Beta
ModelsExpand Collapse
AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 15 more
AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 15 more
Accepts one of the following:
UnionMember0 = string
UnionMember1 = "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 15 more
UnionMember1 = "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 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"
BetaAPIError = object { message, type }
BetaAPIError = object { message, type }
message: string
type: "api_error"
type: "api_error"
Accepts one of the following:
"api_error"
BetaAuthenticationError = object { message, type }
BetaAuthenticationError = object { message, type }
message: string
type: "authentication_error"
type: "authentication_error"
Accepts one of the following:
"authentication_error"
BetaBillingError = object { message, type }
BetaBillingError = object { message, type }
message: string
type: "billing_error"
type: "billing_error"
Accepts one of the following:
"billing_error"
BetaError = BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
BetaError = BetaInvalidRequestError { message, type } or BetaAuthenticationError { message, type } or BetaBillingError { message, type } or 6 more
Accepts one of the following:
BetaInvalidRequestError = object { message, type }
BetaInvalidRequestError = object { message, type }
message: string
type: "invalid_request_error"
type: "invalid_request_error"
Accepts one of the following:
"invalid_request_error"
BetaAuthenticationError = object { message, type }
BetaAuthenticationError = object { message, type }
message: string
type: "authentication_error"
type: "authentication_error"
Accepts one of the following:
"authentication_error"
BetaBillingError = object { message, type }
BetaBillingError = object { message, type }
message: string
type: "billing_error"
type: "billing_error"
Accepts one of the following:
"billing_error"
BetaPermissionError = object { message, type }
BetaPermissionError = object { message, type }
message: string
type: "permission_error"
type: "permission_error"
Accepts one of the following:
"permission_error"
BetaNotFoundError = object { message, type }
BetaNotFoundError = object { message, type }
message: string
type: "not_found_error"
type: "not_found_error"
Accepts one of the following:
"not_found_error"
BetaRateLimitError = object { message, type }
BetaRateLimitError = object { message, type }
message: string
type: "rate_limit_error"
type: "rate_limit_error"
Accepts one of the following:
"rate_limit_error"
BetaGatewayTimeoutError = object { message, type }
BetaGatewayTimeoutError = object { message, type }
message: string
type: "timeout_error"
type: "timeout_error"
Accepts one of the following:
"timeout_error"
BetaAPIError = object { message, type }
BetaAPIError = object { message, type }
message: string
type: "api_error"
type: "api_error"
Accepts one of the following:
"api_error"
BetaOverloadedError = object { message, type }
BetaOverloadedError = object { message, type }
message: string
type: "overloaded_error"
type: "overloaded_error"
Accepts one of the following:
"overloaded_error"
BetaErrorResponse = object { error, request_id, type }
BetaErrorResponse = object { error, request_id, type }
Accepts one of the following:
BetaInvalidRequestError = object { message, type }
BetaInvalidRequestError = object { message, type }
message: string
type: "invalid_request_error"
type: "invalid_request_error"
Accepts one of the following:
"invalid_request_error"
BetaAuthenticationError = object { message, type }
BetaAuthenticationError = object { message, type }
message: string
type: "authentication_error"
type: "authentication_error"
Accepts one of the following:
"authentication_error"
BetaBillingError = object { message, type }
BetaBillingError = object { message, type }
message: string
type: "billing_error"
type: "billing_error"
Accepts one of the following:
"billing_error"
BetaPermissionError = object { message, type }
BetaPermissionError = object { message, type }
message: string
type: "permission_error"
type: "permission_error"
Accepts one of the following:
"permission_error"
BetaNotFoundError = object { message, type }
BetaNotFoundError = object { message, type }
message: string
type: "not_found_error"
type: "not_found_error"
Accepts one of the following:
"not_found_error"
BetaRateLimitError = object { message, type }
BetaRateLimitError = object { message, type }
message: string
type: "rate_limit_error"
type: "rate_limit_error"
Accepts one of the following:
"rate_limit_error"
BetaGatewayTimeoutError = object { message, type }
BetaGatewayTimeoutError = object { message, type }
message: string
type: "timeout_error"
type: "timeout_error"
Accepts one of the following:
"timeout_error"
BetaAPIError = object { message, type }
BetaAPIError = object { message, type }
message: string
type: "api_error"
type: "api_error"
Accepts one of the following:
"api_error"
BetaOverloadedError = object { message, type }
BetaOverloadedError = object { message, type }
message: string
type: "overloaded_error"
type: "overloaded_error"
Accepts one of the following:
"overloaded_error"
request_id: string
type: "error"
type: "error"
Accepts one of the following:
"error"
BetaGatewayTimeoutError = object { message, type }
BetaGatewayTimeoutError = object { message, type }
message: string
type: "timeout_error"
type: "timeout_error"
Accepts one of the following:
"timeout_error"
BetaInvalidRequestError = object { message, type }
BetaInvalidRequestError = object { message, type }
message: string
type: "invalid_request_error"
type: "invalid_request_error"
Accepts one of the following:
"invalid_request_error"
BetaNotFoundError = object { message, type }
BetaNotFoundError = object { message, type }
message: string
type: "not_found_error"
type: "not_found_error"
Accepts one of the following:
"not_found_error"
BetaOverloadedError = object { message, type }
BetaOverloadedError = object { message, type }
message: string
type: "overloaded_error"
type: "overloaded_error"
Accepts one of the following:
"overloaded_error"
BetaPermissionError = object { message, type }
BetaPermissionError = object { message, type }
message: string
type: "permission_error"
type: "permission_error"
Accepts one of the following:
"permission_error"
BetaRateLimitError = object { message, type }
BetaRateLimitError = object { message, type }
message: string
type: "rate_limit_error"
type: "rate_limit_error"
Accepts one of the following:
"rate_limit_error"
BetaFiles
Delete File
delete/v1/files/{file_id}?beta=true
Download File
get/v1/files/{file_id}/content?beta=true
List Files
get/v1/files?beta=true
Get File Metadata
get/v1/files/{file_id}?beta=true
Upload File
post/v1/files?beta=true
ModelsExpand Collapse
DeletedFile = object { id, type }
DeletedFile = object { id, type }
id: string
ID of the deleted file.
type: optional "file_deleted"Deleted object type.
For file deletion, this is always "file_deleted".
type: optional "file_deleted"
Deleted object type.
For file deletion, this is always "file_deleted".
Accepts one of the following:
"file_deleted"
FileMetadata = object { id, created_at, filename, 4 more }
FileMetadata = object { id, created_at, filename, 4 more }
id: string
Unique object identifier.
The format and length of IDs may change over time.
created_at: string
RFC 3339 datetime string representing when the file was created.
formatdate-time
filename: string
Original filename of the uploaded file.
maxLength500
minLength1
mime_type: string
MIME type of the file.
maxLength255
minLength1
size_bytes: number
Size of the file in bytes.
minimum0
type: "file"Object type.
For files, this is always "file".
type: "file"
Object type.
For files, this is always "file".
Accepts one of the following:
"file"
downloadable: optional boolean
Whether the file can be downloaded.
BetaMessages
Count tokens in a Message
post/v1/messages/count_tokens?beta=true
Create a Message
post/v1/messages?beta=true
ModelsExpand Collapse
BetaAllThinkingTurns = object { type }
BetaAllThinkingTurns = object { type }
type: "all"
type: "all"
Accepts one of the following:
"all"
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaBashCodeExecutionOutputBlock = object { file_id, type }
BetaBashCodeExecutionOutputBlock = object { file_id, type }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
BetaBashCodeExecutionOutputBlockParam = object { file_id, type }
BetaBashCodeExecutionOutputBlockParam = object { file_id, type }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } or BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } or BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaCacheControlEphemeral = object { type, ttl }
BetaCacheControlEphemeral = object { type, ttl }
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCacheCreation = object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
BetaCacheCreation = object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationConfig = object { enabled }
BetaCitationConfig = object { enabled }
enabled: boolean
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationsConfigParam = object { enabled }
BetaCitationsConfigParam = object { enabled }
enabled: optional boolean
BetaCitationsDelta = object { citation, type }
BetaCitationsDelta = object { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
Accepts one of the following:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
type: "citations_delta"
type: "citations_delta"
Accepts one of the following:
"citations_delta"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaClearThinking20251015Edit = object { type, keep }
BetaClearThinking20251015Edit = object { type, keep }
type: "clear_thinking_20251015"
type: "clear_thinking_20251015"
Accepts one of the following:
"clear_thinking_20251015"
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Accepts one of the following:
BetaThinkingTurns = object { type, value }
BetaThinkingTurns = object { type, value }
type: "thinking_turns"
type: "thinking_turns"
Accepts one of the following:
"thinking_turns"
value: number
minimum1
BetaAllThinkingTurns = object { type }
BetaAllThinkingTurns = object { type }
type: "all"
type: "all"
Accepts one of the following:
"all"
UnionMember2 = "all"
UnionMember2 = "all"
Accepts one of the following:
"all"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
BetaClearToolUses20250919Edit = object { type, clear_at_least, clear_tool_inputs, 3 more }
BetaClearToolUses20250919Edit = object { type, clear_at_least, clear_tool_inputs, 3 more }
type: "clear_tool_uses_20250919"
type: "clear_tool_uses_20250919"
Accepts one of the following:
"clear_tool_uses_20250919"
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
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: "input_tokens"
type: "input_tokens"
Accepts one of the following:
"input_tokens"
value: number
minimum0
clear_tool_inputs: optional boolean or array of stringWhether to clear all tool inputs (bool) or specific tool inputs to clear (list)
clear_tool_inputs: optional boolean or array of string
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Accepts one of the following:
UnionMember0 = boolean
UnionMember1 = array of string
exclude_tools: optional array of string
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
Number of tool uses to retain in the conversation
type: "tool_uses"
type: "tool_uses"
Accepts one of the following:
"tool_uses"
value: number
minimum0
Condition that triggers the context management strategy
Condition that triggers the context management strategy
Accepts one of the following:
BetaInputTokensTrigger = object { type, value }
BetaInputTokensTrigger = object { type, value }
type: "input_tokens"
type: "input_tokens"
Accepts one of the following:
"input_tokens"
value: number
minimum1
BetaToolUsesTrigger = object { type, value }
BetaToolUsesTrigger = object { type, value }
type: "tool_uses"
type: "tool_uses"
Accepts one of the following:
"tool_uses"
value: number
minimum1
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaCodeExecutionOutputBlock = object { file_id, type }
BetaCodeExecutionOutputBlock = object { file_id, type }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
BetaCodeExecutionOutputBlockParam = object { file_id, type }
BetaCodeExecutionOutputBlockParam = object { file_id, type }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
BetaCodeExecutionTool20250522 = object { name, type, cache_control }
BetaCodeExecutionTool20250522 = object { name, type, cache_control }
name: "code_execution"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "code_execution_20250522"
type: "code_execution_20250522"
Accepts one of the following:
"code_execution_20250522"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionTool20250825 = object { name, type, cache_control }
BetaCodeExecutionTool20250825 = object { name, type, cache_control }
name: "code_execution"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "code_execution_20250825"
type: "code_execution_20250825"
Accepts one of the following:
"code_execution_20250825"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaCodeExecutionToolResultBlockContent = BetaCodeExecutionToolResultError { error_code, type } or BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
BetaCodeExecutionToolResultBlockContent = BetaCodeExecutionToolResultError { error_code, type } or BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Accepts one of the following:
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultErrorParam { error_code, type } or BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultErrorParam { error_code, type } or BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionToolResultErrorCode = "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"
BetaCodeExecutionToolResultErrorCode = "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaContainer = object { id, expires_at, skills } Information about the container used in the request (for the code execution tool)
BetaContainer = object { id, expires_at, skills }
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
Skill version or 'latest' for most recent version
maxLength64
minLength1
BetaContainerParams = object { id, skills } Container parameters with skills to be loaded.
BetaContainerParams = object { id, skills }
Container parameters with skills to be loaded.
id: optional string
Container id
List of skills to load in the container
List of skills to load in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: optional string
Skill version or 'latest' for most recent version
maxLength64
minLength1
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
BetaContainerUploadBlockParam = object { file_id, type, cache_control } A content block that represents a file to be uploaded to the container
Files uploaded via this block will be available in the container's input directory.
BetaContainerUploadBlockParam = object { file_id, type, cache_control }
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaContentBlock = BetaTextBlock { citations, text, type } or BetaThinkingBlock { signature, thinking, type } or BetaRedactedThinkingBlock { data, type } or 10 moreResponse model for a file uploaded to the container.
BetaContentBlock = BetaTextBlock { citations, text, type } or BetaThinkingBlock { signature, thinking, type } or BetaRedactedThinkingBlock { data, type } or 10 more
Response model for a file uploaded to the container.
Accepts one of the following:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
BetaContentBlockParam = BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaRequestDocumentBlock { source, type, cache_control, 3 more } or 14 moreRegular text content.
BetaContentBlockParam = BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaRequestDocumentBlock { source, type, cache_control, 3 more } or 14 more
Regular text content.
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
BetaSearchResultBlockParam = object { content, source, title, 3 more }
BetaSearchResultBlockParam = object { content, source, title, 3 more }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
source: string
title: string
type: "search_result"
type: "search_result"
Accepts one of the following:
"search_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
BetaThinkingBlockParam = object { signature, thinking, type }
BetaThinkingBlockParam = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlockParam = object { data, type }
BetaRedactedThinkingBlockParam = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlockParam = object { id, input, name, 2 more }
BetaToolUseBlockParam = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
maxLength200
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
tool_use_id: string
type: "tool_result"
type: "tool_result"
Accepts one of the following:
"tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 string or array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
content: optional string or array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
Accepts one of the following:
UnionMember0 = string
UnionMember1 = array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
UnionMember1 = array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaSearchResultBlockParam = object { content, source, title, 3 more }
BetaSearchResultBlockParam = object { content, source, title, 3 more }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
source: string
title: string
type: "search_result"
type: "search_result"
Accepts one of the following:
"search_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
is_error: optional boolean
BetaServerToolUseBlockParam = object { id, input, name, 2 more }
BetaServerToolUseBlockParam = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Accepts one of the following:
encrypted_content: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
page_age: optional string
BetaWebSearchToolRequestError = object { error_code, type }
BetaWebSearchToolRequestError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } or BetaWebFetchBlockParam { content, type, url, retrieved_at }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } or BetaWebFetchBlockParam { content, type, url, retrieved_at }
Accepts one of the following:
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
retrieved_at: optional string
ISO 8601 timestamp when the content was retrieved
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Accepts one of the following:
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } or BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } or BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
error_message: optional string
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
num_lines: optional number
start_line: optional number
total_lines: optional number
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
lines: optional array of string
new_lines: optional number
new_start: optional number
old_lines: optional number
old_start: optional number
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaMCPToolUseBlockParam = object { id, input, name, 3 more }
BetaMCPToolUseBlockParam = object { id, input, name, 3 more }
id: string
input: map[unknown]
name: string
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
UnionMember0 = string
BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam { text, type, cache_control, citations }
BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
is_error: optional boolean
BetaContainerUploadBlockParam = object { file_id, type, cache_control } A content block that represents a file to be uploaded to the container
Files uploaded via this block will be available in the container's input directory.
BetaContainerUploadBlockParam = object { file_id, type, cache_control }
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaContentBlockSourceContent = BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control }
BetaContentBlockSourceContent = BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control }
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaContextManagementConfig = object { edits }
BetaContextManagementConfig = object { edits }
edits: optional array of BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more } or BetaClearThinking20251015Edit { type, keep } List of context management edits to apply
edits: optional array of BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more } or BetaClearThinking20251015Edit { type, keep }
List of context management edits to apply
Accepts one of the following:
BetaClearToolUses20250919Edit = object { type, clear_at_least, clear_tool_inputs, 3 more }
BetaClearToolUses20250919Edit = object { type, clear_at_least, clear_tool_inputs, 3 more }
type: "clear_tool_uses_20250919"
type: "clear_tool_uses_20250919"
Accepts one of the following:
"clear_tool_uses_20250919"
Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.
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: "input_tokens"
type: "input_tokens"
Accepts one of the following:
"input_tokens"
value: number
minimum0
clear_tool_inputs: optional boolean or array of stringWhether to clear all tool inputs (bool) or specific tool inputs to clear (list)
clear_tool_inputs: optional boolean or array of string
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
Accepts one of the following:
UnionMember0 = boolean
UnionMember1 = array of string
exclude_tools: optional array of string
Tool names whose uses are preserved from clearing
Number of tool uses to retain in the conversation
Number of tool uses to retain in the conversation
type: "tool_uses"
type: "tool_uses"
Accepts one of the following:
"tool_uses"
value: number
minimum0
Condition that triggers the context management strategy
Condition that triggers the context management strategy
Accepts one of the following:
BetaInputTokensTrigger = object { type, value }
BetaInputTokensTrigger = object { type, value }
type: "input_tokens"
type: "input_tokens"
Accepts one of the following:
"input_tokens"
value: number
minimum1
BetaToolUsesTrigger = object { type, value }
BetaToolUsesTrigger = object { type, value }
type: "tool_uses"
type: "tool_uses"
Accepts one of the following:
"tool_uses"
value: number
minimum1
BetaClearThinking20251015Edit = object { type, keep }
BetaClearThinking20251015Edit = object { type, keep }
type: "clear_thinking_20251015"
type: "clear_thinking_20251015"
Accepts one of the following:
"clear_thinking_20251015"
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Accepts one of the following:
BetaThinkingTurns = object { type, value }
BetaThinkingTurns = object { type, value }
type: "thinking_turns"
type: "thinking_turns"
Accepts one of the following:
"thinking_turns"
value: number
minimum1
BetaAllThinkingTurns = object { type }
BetaAllThinkingTurns = object { type }
type: "all"
type: "all"
Accepts one of the following:
"all"
UnionMember2 = "all"
UnionMember2 = "all"
Accepts one of the following:
"all"
BetaContextManagementResponse = object { applied_edits }
BetaContextManagementResponse = object { applied_edits }
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
BetaCountTokensContextManagementResponse = object { original_input_tokens }
BetaCountTokensContextManagementResponse = object { original_input_tokens }
original_input_tokens: number
The original token count before context management was applied
BetaDocumentBlock = object { citations, source, title, type }
BetaDocumentBlock = object { citations, source, title, type }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaInputJSONDelta = object { partial_json, type }
BetaInputJSONDelta = object { partial_json, type }
partial_json: string
type: "input_json_delta"
type: "input_json_delta"
Accepts one of the following:
"input_json_delta"
BetaInputTokensClearAtLeast = object { type, value }
BetaInputTokensClearAtLeast = object { type, value }
type: "input_tokens"
type: "input_tokens"
Accepts one of the following:
"input_tokens"
value: number
minimum0
BetaInputTokensTrigger = object { type, value }
BetaInputTokensTrigger = object { type, value }
type: "input_tokens"
type: "input_tokens"
Accepts one of the following:
"input_tokens"
value: number
minimum1
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolUseBlockParam = object { id, input, name, 3 more }
BetaMCPToolUseBlockParam = object { id, input, name, 3 more }
id: string
input: map[unknown]
name: string
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaMemoryTool20250818 = object { name, type, cache_control }
BetaMemoryTool20250818 = object { name, type, cache_control }
name: "memory"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "memory_20250818"
type: "memory_20250818"
Accepts one of the following:
"memory_20250818"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaMemoryTool20250818Command = BetaMemoryTool20250818ViewCommand { command, path, view_range } or BetaMemoryTool20250818CreateCommand { command, file_text, path } or BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path } or 3 more
BetaMemoryTool20250818Command = BetaMemoryTool20250818ViewCommand { command, path, view_range } or BetaMemoryTool20250818CreateCommand { command, file_text, path } or BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path } or 3 more
Accepts one of the following:
BetaMemoryTool20250818ViewCommand = object { command, path, view_range }
BetaMemoryTool20250818ViewCommand = object { command, path, view_range }
command: "view"Command type identifier
command: "view"
Command type identifier
Accepts one of the following:
"view"
path: string
Path to directory or file to view
view_range: optional array of number
Optional line range for viewing specific lines
BetaMemoryTool20250818CreateCommand = object { command, file_text, path }
BetaMemoryTool20250818CreateCommand = object { command, file_text, path }
command: "create"Command type identifier
command: "create"
Command type identifier
Accepts one of the following:
"create"
file_text: string
Content to write to the file
path: string
Path where the file should be created
BetaMemoryTool20250818StrReplaceCommand = object { command, new_str, old_str, path }
BetaMemoryTool20250818StrReplaceCommand = object { command, new_str, old_str, path }
command: "str_replace"Command type identifier
command: "str_replace"
Command type identifier
Accepts one of the following:
"str_replace"
new_str: string
Text to replace with
old_str: string
Text to search for and replace
path: string
Path to the file where text should be replaced
BetaMemoryTool20250818InsertCommand = object { command, insert_line, insert_text, path }
BetaMemoryTool20250818InsertCommand = object { command, insert_line, insert_text, path }
command: "insert"Command type identifier
command: "insert"
Command type identifier
Accepts one of the following:
"insert"
insert_line: number
Line number where text should be inserted
minimum1
insert_text: string
Text to insert at the specified line
path: string
Path to the file where text should be inserted
BetaMemoryTool20250818DeleteCommand = object { command, path }
BetaMemoryTool20250818DeleteCommand = object { command, path }
command: "delete"Command type identifier
command: "delete"
Command type identifier
Accepts one of the following:
"delete"
path: string
Path to the file or directory to delete
BetaMemoryTool20250818RenameCommand = object { command, new_path, old_path }
BetaMemoryTool20250818RenameCommand = object { command, new_path, old_path }
command: "rename"Command type identifier
command: "rename"
Command type identifier
Accepts one of the following:
"rename"
new_path: string
New path for the file or directory
old_path: string
Current path of the file or directory
BetaMemoryTool20250818CreateCommand = object { command, file_text, path }
BetaMemoryTool20250818CreateCommand = object { command, file_text, path }
command: "create"Command type identifier
command: "create"
Command type identifier
Accepts one of the following:
"create"
file_text: string
Content to write to the file
path: string
Path where the file should be created
BetaMemoryTool20250818DeleteCommand = object { command, path }
BetaMemoryTool20250818DeleteCommand = object { command, path }
command: "delete"Command type identifier
command: "delete"
Command type identifier
Accepts one of the following:
"delete"
path: string
Path to the file or directory to delete
BetaMemoryTool20250818InsertCommand = object { command, insert_line, insert_text, path }
BetaMemoryTool20250818InsertCommand = object { command, insert_line, insert_text, path }
command: "insert"Command type identifier
command: "insert"
Command type identifier
Accepts one of the following:
"insert"
insert_line: number
Line number where text should be inserted
minimum1
insert_text: string
Text to insert at the specified line
path: string
Path to the file where text should be inserted
BetaMemoryTool20250818RenameCommand = object { command, new_path, old_path }
BetaMemoryTool20250818RenameCommand = object { command, new_path, old_path }
command: "rename"Command type identifier
command: "rename"
Command type identifier
Accepts one of the following:
"rename"
new_path: string
New path for the file or directory
old_path: string
Current path of the file or directory
BetaMemoryTool20250818StrReplaceCommand = object { command, new_str, old_str, path }
BetaMemoryTool20250818StrReplaceCommand = object { command, new_str, old_str, path }
command: "str_replace"Command type identifier
command: "str_replace"
Command type identifier
Accepts one of the following:
"str_replace"
new_str: string
Text to replace with
old_str: string
Text to search for and replace
path: string
Path to the file where text should be replaced
BetaMemoryTool20250818ViewCommand = object { command, path, view_range }
BetaMemoryTool20250818ViewCommand = object { command, path, view_range }
command: "view"Command type identifier
command: "view"
Command type identifier
Accepts one of the following:
"view"
path: string
Path to directory or file to view
view_range: optional array of number
Optional line range for viewing specific lines
BetaMessage = object { id, container, content, 7 more }
BetaMessage = object { id, container, content, 7 more }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
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:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 more
The model that will complete your prompt.
See models for additional details and options.
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 = string
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
"assistant"
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.
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: string
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: "message"Object type.
For Messages, this is always "message".
type: "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.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
BetaMessageDeltaUsage = object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
BetaMessageDeltaUsage = object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
cache_creation_input_tokens: number
The cumulative number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The cumulative number of input tokens read from the cache.
minimum0
input_tokens: number
The cumulative number of input tokens which were used.
minimum0
output_tokens: number
The cumulative number of output tokens which were used.
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
BetaMessageParam = object { content, role }
BetaMessageParam = object { content, role }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
BetaSearchResultBlockParam = object { content, source, title, 3 more }
BetaSearchResultBlockParam = object { content, source, title, 3 more }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
source: string
title: string
type: "search_result"
type: "search_result"
Accepts one of the following:
"search_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
BetaThinkingBlockParam = object { signature, thinking, type }
BetaThinkingBlockParam = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlockParam = object { data, type }
BetaRedactedThinkingBlockParam = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlockParam = object { id, input, name, 2 more }
BetaToolUseBlockParam = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
maxLength200
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
tool_use_id: string
type: "tool_result"
type: "tool_result"
Accepts one of the following:
"tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 string or array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
content: optional string or array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
Accepts one of the following:
UnionMember0 = string
UnionMember1 = array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
UnionMember1 = array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaSearchResultBlockParam = object { content, source, title, 3 more }
BetaSearchResultBlockParam = object { content, source, title, 3 more }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
source: string
title: string
type: "search_result"
type: "search_result"
Accepts one of the following:
"search_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
is_error: optional boolean
BetaServerToolUseBlockParam = object { id, input, name, 2 more }
BetaServerToolUseBlockParam = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Accepts one of the following:
encrypted_content: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
page_age: optional string
BetaWebSearchToolRequestError = object { error_code, type }
BetaWebSearchToolRequestError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } or BetaWebFetchBlockParam { content, type, url, retrieved_at }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } or BetaWebFetchBlockParam { content, type, url, retrieved_at }
Accepts one of the following:
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
retrieved_at: optional string
ISO 8601 timestamp when the content was retrieved
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Accepts one of the following:
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
BetaCodeExecutionToolResultErrorParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } or BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } or BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
error_message: optional string
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
num_lines: optional number
start_line: optional number
total_lines: optional number
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
lines: optional array of string
new_lines: optional number
new_start: optional number
old_lines: optional number
old_start: optional number
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaMCPToolUseBlockParam = object { id, input, name, 3 more }
BetaMCPToolUseBlockParam = object { id, input, name, 3 more }
id: string
input: map[unknown]
name: string
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
UnionMember0 = string
BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam { text, type, cache_control, citations }
BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
is_error: optional boolean
BetaContainerUploadBlockParam = object { file_id, type, cache_control } A content block that represents a file to be uploaded to the container
Files uploaded via this block will be available in the container's input directory.
BetaContainerUploadBlockParam = object { file_id, type, cache_control }
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "user" or "assistant"
role: "user" or "assistant"
Accepts one of the following:
"user"
"assistant"
BetaMessageTokensCount = object { context_management, input_tokens }
BetaMessageTokensCount = object { context_management, input_tokens }
Information about context management applied to the message.
Information about context management applied to the message.
original_input_tokens: number
The original token count before context management was applied
input_tokens: number
The total number of tokens across the provided list of messages, system prompt, and tools.
BetaMetadata = object { user_id }
BetaMetadata = object { user_id }
user_id: optional string
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
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaRawContentBlockDelta = BetaTextDelta { text, type } or BetaInputJSONDelta { partial_json, type } or BetaCitationsDelta { citation, type } or 2 more
BetaRawContentBlockDelta = BetaTextDelta { text, type } or BetaInputJSONDelta { partial_json, type } or BetaCitationsDelta { citation, type } or 2 more
Accepts one of the following:
BetaTextDelta = object { text, type }
BetaTextDelta = object { text, type }
text: string
type: "text_delta"
type: "text_delta"
Accepts one of the following:
"text_delta"
BetaInputJSONDelta = object { partial_json, type }
BetaInputJSONDelta = object { partial_json, type }
partial_json: string
type: "input_json_delta"
type: "input_json_delta"
Accepts one of the following:
"input_json_delta"
BetaCitationsDelta = object { citation, type }
BetaCitationsDelta = object { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
Accepts one of the following:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
type: "citations_delta"
type: "citations_delta"
Accepts one of the following:
"citations_delta"
BetaThinkingDelta = object { thinking, type }
BetaThinkingDelta = object { thinking, type }
thinking: string
type: "thinking_delta"
type: "thinking_delta"
Accepts one of the following:
"thinking_delta"
BetaSignatureDelta = object { signature, type }
BetaSignatureDelta = object { signature, type }
signature: string
type: "signature_delta"
type: "signature_delta"
Accepts one of the following:
"signature_delta"
BetaRawContentBlockDeltaEvent = object { delta, index, type }
BetaRawContentBlockDeltaEvent = object { delta, index, type }
Accepts one of the following:
BetaTextDelta = object { text, type }
BetaTextDelta = object { text, type }
text: string
type: "text_delta"
type: "text_delta"
Accepts one of the following:
"text_delta"
BetaInputJSONDelta = object { partial_json, type }
BetaInputJSONDelta = object { partial_json, type }
partial_json: string
type: "input_json_delta"
type: "input_json_delta"
Accepts one of the following:
"input_json_delta"
BetaCitationsDelta = object { citation, type }
BetaCitationsDelta = object { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
Accepts one of the following:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
type: "citations_delta"
type: "citations_delta"
Accepts one of the following:
"citations_delta"
BetaThinkingDelta = object { thinking, type }
BetaThinkingDelta = object { thinking, type }
thinking: string
type: "thinking_delta"
type: "thinking_delta"
Accepts one of the following:
"thinking_delta"
BetaSignatureDelta = object { signature, type }
BetaSignatureDelta = object { signature, type }
signature: string
type: "signature_delta"
type: "signature_delta"
Accepts one of the following:
"signature_delta"
index: number
type: "content_block_delta"
type: "content_block_delta"
Accepts one of the following:
"content_block_delta"
BetaRawContentBlockStartEvent = object { content_block, index, type }
BetaRawContentBlockStartEvent = object { content_block, index, type }
content_block: BetaTextBlock { citations, text, type } or BetaThinkingBlock { signature, thinking, type } or BetaRedactedThinkingBlock { data, type } or 10 moreResponse model for a file uploaded to the container.
content_block: BetaTextBlock { citations, text, type } or BetaThinkingBlock { signature, thinking, type } or BetaRedactedThinkingBlock { data, type } or 10 more
Response model for a file uploaded to the container.
Accepts one of the following:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
index: number
type: "content_block_start"
type: "content_block_start"
Accepts one of the following:
"content_block_start"
BetaRawContentBlockStopEvent = object { index, type }
BetaRawContentBlockStopEvent = object { index, type }
index: number
type: "content_block_stop"
type: "content_block_stop"
Accepts one of the following:
"content_block_stop"
BetaRawMessageDeltaEvent = object { context_management, delta, type, usage }
BetaRawMessageDeltaEvent = object { context_management, delta, type, usage }
Information about context management strategies applied during the request
Information about context management strategies applied during the request
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
delta: object { container, stop_reason, stop_sequence }
delta: object { container, stop_reason, stop_sequence }
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Accepts one of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"refusal"
"model_context_window_exceeded"
stop_sequence: string
type: "message_delta"
type: "message_delta"
Accepts one of the following:
"message_delta"
usage: BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more } 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.
usage: BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
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: number
The cumulative number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The cumulative number of input tokens read from the cache.
minimum0
input_tokens: number
The cumulative number of input tokens which were used.
minimum0
output_tokens: number
The cumulative number of output tokens which were used.
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
BetaRawMessageStartEvent = object { message, type }
BetaRawMessageStartEvent = object { message, type }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
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:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 more
The model that will complete your prompt.
See models for additional details and options.
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 = string
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
"assistant"
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.
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: string
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: "message"Object type.
For Messages, this is always "message".
type: "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.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: "message_start"
type: "message_start"
Accepts one of the following:
"message_start"
BetaRawMessageStopEvent = object { type }
BetaRawMessageStopEvent = object { type }
type: "message_stop"
type: "message_stop"
Accepts one of the following:
"message_stop"
BetaRawMessageStreamEvent = BetaRawMessageStartEvent { message, type } or BetaRawMessageDeltaEvent { context_management, delta, type, usage } or BetaRawMessageStopEvent { type } or 3 more
BetaRawMessageStreamEvent = BetaRawMessageStartEvent { message, type } or BetaRawMessageDeltaEvent { context_management, delta, type, usage } or BetaRawMessageStopEvent { type } or 3 more
Accepts one of the following:
BetaRawMessageStartEvent = object { message, type }
BetaRawMessageStartEvent = object { message, type }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
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:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 more
The model that will complete your prompt.
See models for additional details and options.
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 = string
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
"assistant"
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.
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: string
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: "message"Object type.
For Messages, this is always "message".
type: "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.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: "message_start"
type: "message_start"
Accepts one of the following:
"message_start"
BetaRawMessageDeltaEvent = object { context_management, delta, type, usage }
BetaRawMessageDeltaEvent = object { context_management, delta, type, usage }
Information about context management strategies applied during the request
Information about context management strategies applied during the request
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
delta: object { container, stop_reason, stop_sequence }
delta: object { container, stop_reason, stop_sequence }
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
Skill version or 'latest' for most recent version
maxLength64
minLength1
Accepts one of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"refusal"
"model_context_window_exceeded"
stop_sequence: string
type: "message_delta"
type: "message_delta"
Accepts one of the following:
"message_delta"
usage: BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more } 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.
usage: BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }
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: number
The cumulative number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The cumulative number of input tokens read from the cache.
minimum0
input_tokens: number
The cumulative number of input tokens which were used.
minimum0
output_tokens: number
The cumulative number of output tokens which were used.
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
BetaRawMessageStopEvent = object { type }
BetaRawMessageStopEvent = object { type }
type: "message_stop"
type: "message_stop"
Accepts one of the following:
"message_stop"
BetaRawContentBlockStartEvent = object { content_block, index, type }
BetaRawContentBlockStartEvent = object { content_block, index, type }
content_block: BetaTextBlock { citations, text, type } or BetaThinkingBlock { signature, thinking, type } or BetaRedactedThinkingBlock { data, type } or 10 moreResponse model for a file uploaded to the container.
content_block: BetaTextBlock { citations, text, type } or BetaThinkingBlock { signature, thinking, type } or BetaRedactedThinkingBlock { data, type } or 10 more
Response model for a file uploaded to the container.
Accepts one of the following:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
index: number
type: "content_block_start"
type: "content_block_start"
Accepts one of the following:
"content_block_start"
BetaRawContentBlockDeltaEvent = object { delta, index, type }
BetaRawContentBlockDeltaEvent = object { delta, index, type }
Accepts one of the following:
BetaTextDelta = object { text, type }
BetaTextDelta = object { text, type }
text: string
type: "text_delta"
type: "text_delta"
Accepts one of the following:
"text_delta"
BetaInputJSONDelta = object { partial_json, type }
BetaInputJSONDelta = object { partial_json, type }
partial_json: string
type: "input_json_delta"
type: "input_json_delta"
Accepts one of the following:
"input_json_delta"
BetaCitationsDelta = object { citation, type }
BetaCitationsDelta = object { citation, type }
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
Accepts one of the following:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
type: "citations_delta"
type: "citations_delta"
Accepts one of the following:
"citations_delta"
BetaThinkingDelta = object { thinking, type }
BetaThinkingDelta = object { thinking, type }
thinking: string
type: "thinking_delta"
type: "thinking_delta"
Accepts one of the following:
"thinking_delta"
BetaSignatureDelta = object { signature, type }
BetaSignatureDelta = object { signature, type }
signature: string
type: "signature_delta"
type: "signature_delta"
Accepts one of the following:
"signature_delta"
index: number
type: "content_block_delta"
type: "content_block_delta"
Accepts one of the following:
"content_block_delta"
BetaRawContentBlockStopEvent = object { index, type }
BetaRawContentBlockStopEvent = object { index, type }
index: number
type: "content_block_stop"
type: "content_block_stop"
Accepts one of the following:
"content_block_stop"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaRedactedThinkingBlockParam = object { data, type }
BetaRedactedThinkingBlockParam = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
BetaRequestMCPServerToolConfiguration = object { allowed_tools, enabled }
BetaRequestMCPServerToolConfiguration = object { allowed_tools, enabled }
allowed_tools: optional array of string
enabled: optional boolean
BetaRequestMCPServerURLDefinition = object { name, type, url, 2 more }
BetaRequestMCPServerURLDefinition = object { name, type, url, 2 more }
name: string
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
authorization_token: optional string
allowed_tools: optional array of string
enabled: optional boolean
BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
UnionMember0 = string
BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam { text, type, cache_control, citations }
BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
is_error: optional boolean
BetaSearchResultBlockParam = object { content, source, title, 3 more }
BetaSearchResultBlockParam = object { content, source, title, 3 more }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
source: string
title: string
type: "search_result"
type: "search_result"
Accepts one of the following:
"search_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
BetaServerToolUsage = object { web_fetch_requests, web_search_requests }
BetaServerToolUsage = object { web_fetch_requests, web_search_requests }
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaServerToolUseBlockParam = object { id, input, name, 2 more }
BetaServerToolUseBlockParam = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaSignatureDelta = object { signature, type }
BetaSignatureDelta = object { signature, type }
signature: string
type: "signature_delta"
type: "signature_delta"
Accepts one of the following:
"signature_delta"
BetaSkill = object { skill_id, type, version } A skill that was loaded in a container (response model).
BetaSkill = object { skill_id, type, version }
A skill that was loaded in a container (response model).
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
Skill version or 'latest' for most recent version
maxLength64
minLength1
BetaSkillParams = object { skill_id, type, version } Specification for a skill to be loaded in a container (request model).
BetaSkillParams = object { skill_id, type, version }
Specification for a skill to be loaded in a container (request model).
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: optional string
Skill version or 'latest' for most recent version
maxLength64
minLength1
BetaStopReason = "end_turn" or "max_tokens" or "stop_sequence" or 4 more
BetaStopReason = "end_turn" or "max_tokens" or "stop_sequence" or 4 more
Accepts one of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"refusal"
"model_context_window_exceeded"
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaTextCitation = BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
BetaTextCitation = BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } or BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } or BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } or 2 more
Accepts one of the following:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaTextCitationParam = BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more } or BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more } or BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more } or 2 more
BetaTextCitationParam = BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more } or BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more } or BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more } or 2 more
Accepts one of the following:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaTextDelta = object { text, type }
BetaTextDelta = object { text, type }
text: string
type: "text_delta"
type: "text_delta"
Accepts one of the following:
"text_delta"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
lines: optional array of string
new_lines: optional number
new_start: optional number
old_lines: optional number
old_start: optional number
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } or BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } or BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
error_message: optional string
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
num_lines: optional number
start_line: optional number
total_lines: optional number
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
lines: optional array of string
new_lines: optional number
new_start: optional number
old_lines: optional number
old_start: optional number
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
error_message: optional string
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
num_lines: optional number
start_line: optional number
total_lines: optional number
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaThinkingBlockParam = object { signature, thinking, type }
BetaThinkingBlockParam = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaThinkingConfigDisabled = object { type }
BetaThinkingConfigDisabled = object { type }
type: "disabled"
type: "disabled"
Accepts one of the following:
"disabled"
BetaThinkingConfigEnabled = object { budget_tokens, type }
BetaThinkingConfigEnabled = object { budget_tokens, type }
budget_tokens: number
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
minimum1024
type: "enabled"
type: "enabled"
Accepts one of the following:
"enabled"
BetaThinkingConfigParam = BetaThinkingConfigEnabled { budget_tokens, type } or BetaThinkingConfigDisabled { type } 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.
BetaThinkingConfigParam = BetaThinkingConfigEnabled { budget_tokens, type } or BetaThinkingConfigDisabled { type }
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:
BetaThinkingConfigEnabled = object { budget_tokens, type }
BetaThinkingConfigEnabled = object { budget_tokens, type }
budget_tokens: number
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
minimum1024
type: "enabled"
type: "enabled"
Accepts one of the following:
"enabled"
BetaThinkingConfigDisabled = object { type }
BetaThinkingConfigDisabled = object { type }
type: "disabled"
type: "disabled"
Accepts one of the following:
"disabled"
BetaThinkingDelta = object { thinking, type }
BetaThinkingDelta = object { thinking, type }
thinking: string
type: "thinking_delta"
type: "thinking_delta"
Accepts one of the following:
"thinking_delta"
BetaThinkingTurns = object { type, value }
BetaThinkingTurns = object { type, value }
type: "thinking_turns"
type: "thinking_turns"
Accepts one of the following:
"thinking_turns"
value: number
minimum1
BetaTool = object { input_schema, name, cache_control, 2 more }
BetaTool = object { input_schema, name, cache_control, 2 more }
input_schema: object { type, properties, required } JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
input_schema: object { type, properties, required }
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: "object"
type: "object"
Accepts one of the following:
"object"
properties: optional map[unknown]
required: optional array of string
name: string
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
maxLength128
minLength1
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 string
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
type: optional "custom"
type: optional "custom"
Accepts one of the following:
"custom"
BetaToolBash20241022 = object { name, type, cache_control }
BetaToolBash20241022 = object { name, type, cache_control }
name: "bash"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "bash_20241022"
type: "bash_20241022"
Accepts one of the following:
"bash_20241022"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolBash20250124 = object { name, type, cache_control }
BetaToolBash20250124 = object { name, type, cache_control }
name: "bash"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "bash_20250124"
type: "bash_20250124"
Accepts one of the following:
"bash_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolChoice = BetaToolChoiceAuto { type, disable_parallel_tool_use } or BetaToolChoiceAny { type, disable_parallel_tool_use } or BetaToolChoiceTool { name, type, disable_parallel_tool_use } or BetaToolChoiceNone { type } 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.
BetaToolChoice = BetaToolChoiceAuto { type, disable_parallel_tool_use } or BetaToolChoiceAny { type, disable_parallel_tool_use } or BetaToolChoiceTool { name, type, disable_parallel_tool_use } or BetaToolChoiceNone { type }
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:
BetaToolChoiceAuto = object { type, disable_parallel_tool_use } The model will automatically decide whether to use tools.
BetaToolChoiceAuto = object { type, disable_parallel_tool_use }
The model will automatically decide whether to use tools.
type: "auto"
type: "auto"
Accepts one of the following:
"auto"
disable_parallel_tool_use: optional boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
BetaToolChoiceAny = object { type, disable_parallel_tool_use } The model will use any available tools.
BetaToolChoiceAny = object { type, disable_parallel_tool_use }
The model will use any available tools.
type: "any"
type: "any"
Accepts one of the following:
"any"
disable_parallel_tool_use: optional boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
BetaToolChoiceTool = object { name, type, disable_parallel_tool_use } The model will use the specified tool with tool_choice.name.
BetaToolChoiceTool = object { name, type, disable_parallel_tool_use }
The model will use the specified tool with tool_choice.name.
name: string
The name of the tool to use.
type: "tool"
type: "tool"
Accepts one of the following:
"tool"
disable_parallel_tool_use: optional boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
BetaToolChoiceNone = object { type } The model will not be allowed to use tools.
BetaToolChoiceNone = object { type }
The model will not be allowed to use tools.
type: "none"
type: "none"
Accepts one of the following:
"none"
BetaToolChoiceAny = object { type, disable_parallel_tool_use } The model will use any available tools.
BetaToolChoiceAny = object { type, disable_parallel_tool_use }
The model will use any available tools.
type: "any"
type: "any"
Accepts one of the following:
"any"
disable_parallel_tool_use: optional boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
BetaToolChoiceAuto = object { type, disable_parallel_tool_use } The model will automatically decide whether to use tools.
BetaToolChoiceAuto = object { type, disable_parallel_tool_use }
The model will automatically decide whether to use tools.
type: "auto"
type: "auto"
Accepts one of the following:
"auto"
disable_parallel_tool_use: optional boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
BetaToolChoiceNone = object { type } The model will not be allowed to use tools.
BetaToolChoiceNone = object { type }
The model will not be allowed to use tools.
type: "none"
type: "none"
Accepts one of the following:
"none"
BetaToolChoiceTool = object { name, type, disable_parallel_tool_use } The model will use the specified tool with tool_choice.name.
BetaToolChoiceTool = object { name, type, disable_parallel_tool_use }
The model will use the specified tool with tool_choice.name.
name: string
The name of the tool to use.
type: "tool"
type: "tool"
Accepts one of the following:
"tool"
disable_parallel_tool_use: optional boolean
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
BetaToolComputerUse20241022 = object { display_height_px, display_width_px, name, 3 more }
BetaToolComputerUse20241022 = object { display_height_px, display_width_px, name, 3 more }
display_height_px: number
The height of the display in pixels.
minimum1
display_width_px: number
The width of the display in pixels.
minimum1
name: "computer"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "computer_20241022"
type: "computer_20241022"
Accepts one of the following:
"computer_20241022"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
The X11 display number (e.g. 0, 1) for the display.
minimum0
BetaToolComputerUse20250124 = object { display_height_px, display_width_px, name, 3 more }
BetaToolComputerUse20250124 = object { display_height_px, display_width_px, name, 3 more }
display_height_px: number
The height of the display in pixels.
minimum1
display_width_px: number
The width of the display in pixels.
minimum1
name: "computer"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "computer_20250124"
type: "computer_20250124"
Accepts one of the following:
"computer_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
The X11 display number (e.g. 0, 1) for the display.
minimum0
BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }
tool_use_id: string
type: "tool_result"
type: "tool_result"
Accepts one of the following:
"tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 string or array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
content: optional string or array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
Accepts one of the following:
UnionMember0 = string
UnionMember1 = array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
UnionMember1 = array of BetaTextBlockParam { text, type, cache_control, citations } or BetaImageBlockParam { source, type, cache_control } or BetaSearchResultBlockParam { content, source, title, 3 more } or BetaRequestDocumentBlock { source, type, cache_control, 3 more }
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaSearchResultBlockParam = object { content, source, title, 3 more }
BetaSearchResultBlockParam = object { content, source, title, 3 more }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
source: string
title: string
type: "search_result"
type: "search_result"
Accepts one of the following:
"search_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
is_error: optional boolean
BetaToolTextEditor20241022 = object { name, type, cache_control }
BetaToolTextEditor20241022 = object { name, type, cache_control }
name: "str_replace_editor"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "text_editor_20241022"
type: "text_editor_20241022"
Accepts one of the following:
"text_editor_20241022"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolTextEditor20250124 = object { name, type, cache_control }
BetaToolTextEditor20250124 = object { name, type, cache_control }
name: "str_replace_editor"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "text_editor_20250124"
type: "text_editor_20250124"
Accepts one of the following:
"text_editor_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolTextEditor20250429 = object { name, type, cache_control }
BetaToolTextEditor20250429 = object { name, type, cache_control }
name: "str_replace_based_edit_tool"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "str_replace_based_edit_tool"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: "text_editor_20250429"
type: "text_editor_20250429"
Accepts one of the following:
"text_editor_20250429"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolTextEditor20250728 = object { name, type, cache_control, max_characters }
BetaToolTextEditor20250728 = object { name, type, cache_control, max_characters }
name: "str_replace_based_edit_tool"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "str_replace_based_edit_tool"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: "text_editor_20250728"
type: "text_editor_20250728"
Accepts one of the following:
"text_editor_20250728"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
minimum1
BetaToolUnion = BetaTool { input_schema, name, cache_control, 2 more } or BetaToolBash20241022 { name, type, cache_control } or BetaToolBash20250124 { name, type, cache_control } or 11 more
BetaToolUnion = BetaTool { input_schema, name, cache_control, 2 more } or BetaToolBash20241022 { name, type, cache_control } or BetaToolBash20250124 { name, type, cache_control } or 11 more
Accepts one of the following:
BetaTool = object { input_schema, name, cache_control, 2 more }
BetaTool = object { input_schema, name, cache_control, 2 more }
input_schema: object { type, properties, required } JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
input_schema: object { type, properties, required }
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: "object"
type: "object"
Accepts one of the following:
"object"
properties: optional map[unknown]
required: optional array of string
name: string
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
maxLength128
minLength1
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 string
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
type: optional "custom"
type: optional "custom"
Accepts one of the following:
"custom"
BetaToolBash20241022 = object { name, type, cache_control }
BetaToolBash20241022 = object { name, type, cache_control }
name: "bash"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "bash_20241022"
type: "bash_20241022"
Accepts one of the following:
"bash_20241022"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolBash20250124 = object { name, type, cache_control }
BetaToolBash20250124 = object { name, type, cache_control }
name: "bash"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "bash_20250124"
type: "bash_20250124"
Accepts one of the following:
"bash_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionTool20250522 = object { name, type, cache_control }
BetaCodeExecutionTool20250522 = object { name, type, cache_control }
name: "code_execution"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "code_execution_20250522"
type: "code_execution_20250522"
Accepts one of the following:
"code_execution_20250522"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaCodeExecutionTool20250825 = object { name, type, cache_control }
BetaCodeExecutionTool20250825 = object { name, type, cache_control }
name: "code_execution"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "code_execution_20250825"
type: "code_execution_20250825"
Accepts one of the following:
"code_execution_20250825"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolComputerUse20241022 = object { display_height_px, display_width_px, name, 3 more }
BetaToolComputerUse20241022 = object { display_height_px, display_width_px, name, 3 more }
display_height_px: number
The height of the display in pixels.
minimum1
display_width_px: number
The width of the display in pixels.
minimum1
name: "computer"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "computer_20241022"
type: "computer_20241022"
Accepts one of the following:
"computer_20241022"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
The X11 display number (e.g. 0, 1) for the display.
minimum0
BetaMemoryTool20250818 = object { name, type, cache_control }
BetaMemoryTool20250818 = object { name, type, cache_control }
name: "memory"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "memory_20250818"
type: "memory_20250818"
Accepts one of the following:
"memory_20250818"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolComputerUse20250124 = object { display_height_px, display_width_px, name, 3 more }
BetaToolComputerUse20250124 = object { display_height_px, display_width_px, name, 3 more }
display_height_px: number
The height of the display in pixels.
minimum1
display_width_px: number
The width of the display in pixels.
minimum1
name: "computer"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "computer_20250124"
type: "computer_20250124"
Accepts one of the following:
"computer_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
The X11 display number (e.g. 0, 1) for the display.
minimum0
BetaToolTextEditor20241022 = object { name, type, cache_control }
BetaToolTextEditor20241022 = object { name, type, cache_control }
name: "str_replace_editor"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "text_editor_20241022"
type: "text_editor_20241022"
Accepts one of the following:
"text_editor_20241022"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolTextEditor20250124 = object { name, type, cache_control }
BetaToolTextEditor20250124 = object { name, type, cache_control }
name: "str_replace_editor"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "text_editor_20250124"
type: "text_editor_20250124"
Accepts one of the following:
"text_editor_20250124"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolTextEditor20250429 = object { name, type, cache_control }
BetaToolTextEditor20250429 = object { name, type, cache_control }
name: "str_replace_based_edit_tool"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "str_replace_based_edit_tool"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: "text_editor_20250429"
type: "text_editor_20250429"
Accepts one of the following:
"text_editor_20250429"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolTextEditor20250728 = object { name, type, cache_control, max_characters }
BetaToolTextEditor20250728 = object { name, type, cache_control, max_characters }
name: "str_replace_based_edit_tool"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "str_replace_based_edit_tool"
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: "text_editor_20250728"
type: "text_editor_20250728"
Accepts one of the following:
"text_editor_20250728"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
minimum1
BetaWebSearchTool20250305 = object { name, type, allowed_domains, 4 more }
BetaWebSearchTool20250305 = object { name, type, allowed_domains, 4 more }
name: "web_search"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "web_search_20250305"
type: "web_search_20250305"
Accepts one of the following:
"web_search_20250305"
allowed_domains: optional array of string
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains: optional array of string
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
user_location: optional object { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
user_location: optional object { type, city, country, 2 more }
Parameters for the user's location. Used to provide more relevant search results.
type: "approximate"
type: "approximate"
Accepts one of the following:
"approximate"
city: optional string
The city of the user.
maxLength255
minLength1
region: optional string
The region of the user.
maxLength255
minLength1
BetaWebFetchTool20250910 = object { name, type, allowed_domains, 5 more }
BetaWebFetchTool20250910 = object { name, type, allowed_domains, 5 more }
name: "web_fetch"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "web_fetch_20250910"
type: "web_fetch_20250910"
Accepts one of the following:
"web_fetch_20250910"
allowed_domains: optional array of string
List of domains to allow fetching from
blocked_domains: optional array of string
List of domains to block fetching from
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
enabled: optional boolean
max_content_tokens: optional number
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 number
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaToolUseBlockParam = object { id, input, name, 2 more }
BetaToolUseBlockParam = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
maxLength200
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaToolUsesKeep = object { type, value }
BetaToolUsesKeep = object { type, value }
type: "tool_uses"
type: "tool_uses"
Accepts one of the following:
"tool_uses"
value: number
minimum0
BetaToolUsesTrigger = object { type, value }
BetaToolUsesTrigger = object { type, value }
type: "tool_uses"
type: "tool_uses"
Accepts one of the following:
"tool_uses"
value: number
minimum1
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaUsage = object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }
BetaUsage = object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
retrieved_at: optional string
ISO 8601 timestamp when the content was retrieved
BetaWebFetchTool20250910 = object { name, type, allowed_domains, 5 more }
BetaWebFetchTool20250910 = object { name, type, allowed_domains, 5 more }
name: "web_fetch"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "web_fetch_20250910"
type: "web_fetch_20250910"
Accepts one of the following:
"web_fetch_20250910"
allowed_domains: optional array of string
List of domains to allow fetching from
blocked_domains: optional array of string
List of domains to block fetching from
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
enabled: optional boolean
max_content_tokens: optional number
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 number
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } or BetaWebFetchBlockParam { content, type, url, retrieved_at }
content: BetaWebFetchToolResultErrorBlockParam { error_code, type } or BetaWebFetchBlockParam { content, type, url, retrieved_at }
Accepts one of the following:
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
BetaWebFetchBlockParam = object { content, type, url, retrieved_at }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type } or BetaContentBlockSource { content, type } or 2 more
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaContentBlockSource = object { content, type }
BetaContentBlockSource = object { content, type }
Accepts one of the following:
UnionMember0 = string
Accepts one of the following:
BetaTextBlockParam = object { text, type, cache_control, citations }
BetaTextBlockParam = object { text, type, cache_control, citations }
text: string
minLength1
type: "text"
type: "text"
Accepts one of the following:
"text"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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:
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_char_index: number
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_page_number: number
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }
cited_text: string
document_index: number
minimum0
document_title: string
maxLength255
minLength1
end_block_index: number
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
minLength1
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
maxLength2048
minLength1
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
BetaImageBlockParam = object { source, type, cache_control }
BetaImageBlockParam = object { source, type, cache_control }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
source: BetaBase64ImageSource { data, media_type, type } or BetaURLImageSource { type, url } or BetaFileImageSource { file_id, type }
Accepts one of the following:
BetaBase64ImageSource = object { data, media_type, type }
BetaBase64ImageSource = object { data, media_type, type }
data: string
formatbyte
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"
Accepts one of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaURLImageSource = object { type, url }
BetaURLImageSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileImageSource = object { file_id, type }
BetaFileImageSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "image"
type: "image"
Accepts one of the following:
"image"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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: "content"
type: "content"
Accepts one of the following:
"content"
BetaURLPDFSource = object { type, url }
BetaURLPDFSource = object { type, url }
type: "url"
type: "url"
Accepts one of the following:
"url"
url: string
BetaFileDocumentSource = object { file_id, type }
BetaFileDocumentSource = object { file_id, type }
file_id: string
type: "file"
type: "file"
Accepts one of the following:
"file"
type: "document"
type: "document"
Accepts one of the following:
"document"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
enabled: optional boolean
context: optional string
minLength1
title: optional string
maxLength500
minLength1
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
retrieved_at: optional string
ISO 8601 timestamp when the content was retrieved
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
BetaWebFetchToolResultErrorBlockParam = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchToolResultErrorCode = "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 5 more
BetaWebFetchToolResultErrorCode = "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 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"
BetaWebSearchResultBlock = object { encrypted_content, page_age, title, 2 more }
BetaWebSearchResultBlock = object { encrypted_content, page_age, title, 2 more }
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
BetaWebSearchResultBlockParam = object { encrypted_content, title, type, 2 more }
BetaWebSearchResultBlockParam = object { encrypted_content, title, type, 2 more }
encrypted_content: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
page_age: optional string
BetaWebSearchTool20250305 = object { name, type, allowed_domains, 4 more }
BetaWebSearchTool20250305 = object { name, type, allowed_domains, 4 more }
name: "web_search"Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: "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: "web_search_20250305"
type: "web_search_20250305"
Accepts one of the following:
"web_search_20250305"
allowed_domains: optional array of string
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains: optional array of string
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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 number
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
user_location: optional object { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
user_location: optional object { type, city, country, 2 more }
Parameters for the user's location. Used to provide more relevant search results.
type: "approximate"
type: "approximate"
Accepts one of the following:
"approximate"
city: optional string
The city of the user.
maxLength255
minLength1
region: optional string
The region of the user.
maxLength255
minLength1
BetaWebSearchToolRequestError = object { error_code, type }
BetaWebSearchToolRequestError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebSearchToolResultBlockContent = BetaWebSearchToolResultError { error_code, type } or array of BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more }
BetaWebSearchToolResultBlockContent = BetaWebSearchToolResultError { error_code, type } or array of BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }
Accepts one of the following:
encrypted_content: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
page_age: optional string
BetaWebSearchToolRequestError = object { error_code, type }
BetaWebSearchToolRequestError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
type: "ephemeral"
type: "ephemeral"
Accepts one of the following:
"ephemeral"
ttl: optional "5m" or "1h"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 "5m" or "1h"
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"
BetaWebSearchToolResultBlockParamContent = array of BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } or BetaWebSearchToolRequestError { error_code, type }
BetaWebSearchToolResultBlockParamContent = array of BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } or BetaWebSearchToolRequestError { error_code, type }
Accepts one of the following:
encrypted_content: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
page_age: optional string
BetaWebSearchToolRequestError = object { error_code, type }
BetaWebSearchToolRequestError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
BetaWebSearchToolResultErrorCode = "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 2 more
BetaWebSearchToolResultErrorCode = "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 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
post/v1/messages/batches/{message_batch_id}/cancel?beta=true
Create a Message Batch
post/v1/messages/batches?beta=true
Delete a Message Batch
delete/v1/messages/batches/{message_batch_id}?beta=true
List Message Batches
get/v1/messages/batches?beta=true
Retrieve Message Batch results
get/v1/messages/batches/{message_batch_id}/results?beta=true
Retrieve a Message Batch
get/v1/messages/batches/{message_batch_id}?beta=true
ModelsExpand Collapse
BetaDeletedMessageBatch = object { id, type }
BetaDeletedMessageBatch = object { id, type }
id: string
ID of the Message Batch.
type: "message_batch_deleted"Deleted object type.
For Message Batches, this is always "message_batch_deleted".
type: "message_batch_deleted"
Deleted object type.
For Message Batches, this is always "message_batch_deleted".
Accepts one of the following:
"message_batch_deleted"
BetaMessageBatch = object { id, archived_at, cancel_initiated_at, 7 more }
BetaMessageBatch = object { id, archived_at, cancel_initiated_at, 7 more }
id: string
Unique object identifier.
The format and length of IDs may change over time.
archived_at: string
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
formatdate-time
cancel_initiated_at: string
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: string
RFC 3339 datetime string representing the time at which the Message Batch was created.
formatdate-time
ended_at: string
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: string
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: "in_progress" or "canceling" or "ended"Processing status of the Message Batch.
processing_status: "in_progress" or "canceling" or "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: number
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: number
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: number
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
processing: number
Number of requests in the Message Batch that are processing.
succeeded: number
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: string
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: "message_batch"Object type.
For Message Batches, this is always "message_batch".
type: "message_batch"
Object type.
For Message Batches, this is always "message_batch".
Accepts one of the following:
"message_batch"
BetaMessageBatchCanceledResult = object { type }
BetaMessageBatchCanceledResult = object { type }
type: "canceled"
type: "canceled"
Accepts one of the following:
"canceled"
BetaMessageBatchErroredResult = object { error, type }
BetaMessageBatchErroredResult = object { error, type }
Accepts one of the following:
BetaInvalidRequestError = object { message, type }
BetaInvalidRequestError = object { message, type }
message: string
type: "invalid_request_error"
type: "invalid_request_error"
Accepts one of the following:
"invalid_request_error"
BetaAuthenticationError = object { message, type }
BetaAuthenticationError = object { message, type }
message: string
type: "authentication_error"
type: "authentication_error"
Accepts one of the following:
"authentication_error"
BetaBillingError = object { message, type }
BetaBillingError = object { message, type }
message: string
type: "billing_error"
type: "billing_error"
Accepts one of the following:
"billing_error"
BetaPermissionError = object { message, type }
BetaPermissionError = object { message, type }
message: string
type: "permission_error"
type: "permission_error"
Accepts one of the following:
"permission_error"
BetaNotFoundError = object { message, type }
BetaNotFoundError = object { message, type }
message: string
type: "not_found_error"
type: "not_found_error"
Accepts one of the following:
"not_found_error"
BetaRateLimitError = object { message, type }
BetaRateLimitError = object { message, type }
message: string
type: "rate_limit_error"
type: "rate_limit_error"
Accepts one of the following:
"rate_limit_error"
BetaGatewayTimeoutError = object { message, type }
BetaGatewayTimeoutError = object { message, type }
message: string
type: "timeout_error"
type: "timeout_error"
Accepts one of the following:
"timeout_error"
BetaAPIError = object { message, type }
BetaAPIError = object { message, type }
message: string
type: "api_error"
type: "api_error"
Accepts one of the following:
"api_error"
BetaOverloadedError = object { message, type }
BetaOverloadedError = object { message, type }
message: string
type: "overloaded_error"
type: "overloaded_error"
Accepts one of the following:
"overloaded_error"
request_id: string
type: "error"
type: "error"
Accepts one of the following:
"error"
type: "errored"
type: "errored"
Accepts one of the following:
"errored"
BetaMessageBatchExpiredResult = object { type }
BetaMessageBatchExpiredResult = object { type }
type: "expired"
type: "expired"
Accepts one of the following:
"expired"
BetaMessageBatchIndividualResponse = object { custom_id, result } This is a single line in the response .jsonl file and does not represent the response as a whole.
BetaMessageBatchIndividualResponse = object { custom_id, result }
This is a single line in the response .jsonl file and does not represent the response as a whole.
custom_id: string
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:
BetaMessageBatchSucceededResult = object { message, type }
BetaMessageBatchSucceededResult = object { message, type }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
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:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 more
The model that will complete your prompt.
See models for additional details and options.
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 = string
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
"assistant"
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.
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: string
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: "message"Object type.
For Messages, this is always "message".
type: "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.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: "succeeded"
type: "succeeded"
Accepts one of the following:
"succeeded"
BetaMessageBatchErroredResult = object { error, type }
BetaMessageBatchErroredResult = object { error, type }
Accepts one of the following:
BetaInvalidRequestError = object { message, type }
BetaInvalidRequestError = object { message, type }
message: string
type: "invalid_request_error"
type: "invalid_request_error"
Accepts one of the following:
"invalid_request_error"
BetaAuthenticationError = object { message, type }
BetaAuthenticationError = object { message, type }
message: string
type: "authentication_error"
type: "authentication_error"
Accepts one of the following:
"authentication_error"
BetaBillingError = object { message, type }
BetaBillingError = object { message, type }
message: string
type: "billing_error"
type: "billing_error"
Accepts one of the following:
"billing_error"
BetaPermissionError = object { message, type }
BetaPermissionError = object { message, type }
message: string
type: "permission_error"
type: "permission_error"
Accepts one of the following:
"permission_error"
BetaNotFoundError = object { message, type }
BetaNotFoundError = object { message, type }
message: string
type: "not_found_error"
type: "not_found_error"
Accepts one of the following:
"not_found_error"
BetaRateLimitError = object { message, type }
BetaRateLimitError = object { message, type }
message: string
type: "rate_limit_error"
type: "rate_limit_error"
Accepts one of the following:
"rate_limit_error"
BetaGatewayTimeoutError = object { message, type }
BetaGatewayTimeoutError = object { message, type }
message: string
type: "timeout_error"
type: "timeout_error"
Accepts one of the following:
"timeout_error"
BetaAPIError = object { message, type }
BetaAPIError = object { message, type }
message: string
type: "api_error"
type: "api_error"
Accepts one of the following:
"api_error"
BetaOverloadedError = object { message, type }
BetaOverloadedError = object { message, type }
message: string
type: "overloaded_error"
type: "overloaded_error"
Accepts one of the following:
"overloaded_error"
request_id: string
type: "error"
type: "error"
Accepts one of the following:
"error"
type: "errored"
type: "errored"
Accepts one of the following:
"errored"
BetaMessageBatchCanceledResult = object { type }
BetaMessageBatchCanceledResult = object { type }
type: "canceled"
type: "canceled"
Accepts one of the following:
"canceled"
BetaMessageBatchExpiredResult = object { type }
BetaMessageBatchExpiredResult = object { type }
type: "expired"
type: "expired"
Accepts one of the following:
"expired"
BetaMessageBatchRequestCounts = object { canceled, errored, expired, 2 more }
BetaMessageBatchRequestCounts = object { canceled, errored, expired, 2 more }
canceled: number
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: number
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: number
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
processing: number
Number of requests in the Message Batch that are processing.
succeeded: number
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
BetaMessageBatchResult = BetaMessageBatchSucceededResult { message, type } or BetaMessageBatchErroredResult { error, type } or BetaMessageBatchCanceledResult { type } or BetaMessageBatchExpiredResult { type } 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.
BetaMessageBatchResult = BetaMessageBatchSucceededResult { message, type } or BetaMessageBatchErroredResult { error, type } or BetaMessageBatchCanceledResult { type } or BetaMessageBatchExpiredResult { type }
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:
BetaMessageBatchSucceededResult = object { message, type }
BetaMessageBatchSucceededResult = object { message, type }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
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:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 more
The model that will complete your prompt.
See models for additional details and options.
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 = string
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
"assistant"
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.
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: string
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: "message"Object type.
For Messages, this is always "message".
type: "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.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: "succeeded"
type: "succeeded"
Accepts one of the following:
"succeeded"
BetaMessageBatchErroredResult = object { error, type }
BetaMessageBatchErroredResult = object { error, type }
Accepts one of the following:
BetaInvalidRequestError = object { message, type }
BetaInvalidRequestError = object { message, type }
message: string
type: "invalid_request_error"
type: "invalid_request_error"
Accepts one of the following:
"invalid_request_error"
BetaAuthenticationError = object { message, type }
BetaAuthenticationError = object { message, type }
message: string
type: "authentication_error"
type: "authentication_error"
Accepts one of the following:
"authentication_error"
BetaBillingError = object { message, type }
BetaBillingError = object { message, type }
message: string
type: "billing_error"
type: "billing_error"
Accepts one of the following:
"billing_error"
BetaPermissionError = object { message, type }
BetaPermissionError = object { message, type }
message: string
type: "permission_error"
type: "permission_error"
Accepts one of the following:
"permission_error"
BetaNotFoundError = object { message, type }
BetaNotFoundError = object { message, type }
message: string
type: "not_found_error"
type: "not_found_error"
Accepts one of the following:
"not_found_error"
BetaRateLimitError = object { message, type }
BetaRateLimitError = object { message, type }
message: string
type: "rate_limit_error"
type: "rate_limit_error"
Accepts one of the following:
"rate_limit_error"
BetaGatewayTimeoutError = object { message, type }
BetaGatewayTimeoutError = object { message, type }
message: string
type: "timeout_error"
type: "timeout_error"
Accepts one of the following:
"timeout_error"
BetaAPIError = object { message, type }
BetaAPIError = object { message, type }
message: string
type: "api_error"
type: "api_error"
Accepts one of the following:
"api_error"
BetaOverloadedError = object { message, type }
BetaOverloadedError = object { message, type }
message: string
type: "overloaded_error"
type: "overloaded_error"
Accepts one of the following:
"overloaded_error"
request_id: string
type: "error"
type: "error"
Accepts one of the following:
"error"
type: "errored"
type: "errored"
Accepts one of the following:
"errored"
BetaMessageBatchCanceledResult = object { type }
BetaMessageBatchCanceledResult = object { type }
type: "canceled"
type: "canceled"
Accepts one of the following:
"canceled"
BetaMessageBatchExpiredResult = object { type }
BetaMessageBatchExpiredResult = object { type }
type: "expired"
type: "expired"
Accepts one of the following:
"expired"
BetaMessageBatchSucceededResult = object { message, type }
BetaMessageBatchSucceededResult = object { message, type }
id: string
Unique object identifier.
The format and length of IDs may change over time.
Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
id: string
Identifier for the container used in this request
expires_at: string
The time at which the container will expire.
formatdate-time
Skills loaded in the container
Skills loaded in the container
skill_id: string
Skill ID
maxLength64
minLength1
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
type: "anthropic" or "custom"
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Accepts one of the following:
"anthropic"
"custom"
version: string
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:
BetaTextBlock = object { citations, text, type }
BetaTextBlock = object { citations, text, type }
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
BetaThinkingBlock = object { signature, thinking, type }
BetaThinkingBlock = object { signature, thinking, type }
signature: string
thinking: string
type: "thinking"
type: "thinking"
Accepts one of the following:
"thinking"
BetaRedactedThinkingBlock = object { data, type }
BetaRedactedThinkingBlock = object { data, type }
data: string
type: "redacted_thinking"
type: "redacted_thinking"
Accepts one of the following:
"redacted_thinking"
BetaToolUseBlock = object { id, input, name, type }
BetaToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: string
minLength1
type: "tool_use"
type: "tool_use"
Accepts one of the following:
"tool_use"
BetaServerToolUseBlock = object { id, input, name, type }
BetaServerToolUseBlock = object { id, input, name, type }
id: string
input: map[unknown]
name: "web_search" or "web_fetch" or "code_execution" or 2 more
name: "web_search" or "web_fetch" or "code_execution" or 2 more
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: "server_tool_use"
type: "server_tool_use"
Accepts one of the following:
"server_tool_use"
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
BetaWebSearchToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaWebSearchToolResultError = object { error_code, type }
BetaWebSearchToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
type: "web_search_tool_result_error"
type: "web_search_tool_result_error"
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: string
page_age: string
title: string
type: "web_search_result"
type: "web_search_result"
Accepts one of the following:
"web_search_result"
url: string
tool_use_id: string
type: "web_search_tool_result"
type: "web_search_tool_result"
Accepts one of the following:
"web_search_tool_result"
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
BetaWebFetchToolResultBlock = object { content, tool_use_id, type }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
content: BetaWebFetchToolResultErrorBlock { error_code, type } or BetaWebFetchBlock { content, retrieved_at, type, url }
Accepts one of the following:
BetaWebFetchToolResultErrorBlock = object { error_code, type }
BetaWebFetchToolResultErrorBlock = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"url_too_long"
"url_not_allowed"
"url_not_accessible"
"unsupported_content_type"
"too_many_requests"
"max_uses_exceeded"
"unavailable"
type: "web_fetch_tool_result_error"
type: "web_fetch_tool_result_error"
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchBlock = object { content, retrieved_at, type, url }
BetaWebFetchBlock = object { content, retrieved_at, type, url }
Citation configuration for the document
Citation configuration for the document
enabled: boolean
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
source: BetaBase64PDFSource { data, media_type, type } or BetaPlainTextSource { data, media_type, type }
Accepts one of the following:
BetaBase64PDFSource = object { data, media_type, type }
BetaBase64PDFSource = object { data, media_type, type }
data: string
formatbyte
media_type: "application/pdf"
media_type: "application/pdf"
Accepts one of the following:
"application/pdf"
type: "base64"
type: "base64"
Accepts one of the following:
"base64"
BetaPlainTextSource = object { data, media_type, type }
BetaPlainTextSource = object { data, media_type, type }
data: string
media_type: "text/plain"
media_type: "text/plain"
Accepts one of the following:
"text/plain"
type: "text"
type: "text"
Accepts one of the following:
"text"
title: string
The title of the document
type: "document"
type: "document"
Accepts one of the following:
"document"
retrieved_at: string
ISO 8601 timestamp when the content was retrieved
type: "web_fetch_result"
type: "web_fetch_result"
Accepts one of the following:
"web_fetch_result"
url: string
Fetched content URL
tool_use_id: string
type: "web_fetch_tool_result"
type: "web_fetch_tool_result"
Accepts one of the following:
"web_fetch_tool_result"
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }
Accepts one of the following:
BetaCodeExecutionToolResultError = object { error_code, type }
BetaCodeExecutionToolResultError = object { error_code, type }
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: "code_execution_tool_result_error"
type: "code_execution_tool_result_error"
Accepts one of the following:
"code_execution_tool_result_error"
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "code_execution_output"
type: "code_execution_output"
Accepts one of the following:
"code_execution_output"
return_code: number
stderr: string
stdout: string
type: "code_execution_result"
type: "code_execution_result"
Accepts one of the following:
"code_execution_result"
tool_use_id: string
type: "code_execution_tool_result"
type: "code_execution_tool_result"
Accepts one of the following:
"code_execution_tool_result"
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: BetaBashCodeExecutionToolResultError { error_code, type } or BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
Accepts one of the following:
BetaBashCodeExecutionToolResultError = object { error_code, type }
BetaBashCodeExecutionToolResultError = object { error_code, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"output_file_too_large"
type: "bash_code_execution_tool_result_error"
type: "bash_code_execution_tool_result_error"
Accepts one of the following:
"bash_code_execution_tool_result_error"
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }
file_id: string
type: "bash_code_execution_output"
type: "bash_code_execution_output"
Accepts one of the following:
"bash_code_execution_output"
return_code: number
stderr: string
stdout: string
type: "bash_code_execution_result"
type: "bash_code_execution_result"
Accepts one of the following:
"bash_code_execution_result"
tool_use_id: string
type: "bash_code_execution_tool_result"
type: "bash_code_execution_tool_result"
Accepts one of the following:
"bash_code_execution_tool_result"
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } or BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } or BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } or BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
Accepts one of the following:
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
"file_not_found"
error_message: string
type: "text_editor_code_execution_tool_result_error"
type: "text_editor_code_execution_tool_result_error"
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }
content: string
file_type: "text" or "image" or "pdf"
file_type: "text" or "image" or "pdf"
Accepts one of the following:
"text"
"image"
"pdf"
num_lines: number
start_line: number
total_lines: number
type: "text_editor_code_execution_view_result"
type: "text_editor_code_execution_view_result"
Accepts one of the following:
"text_editor_code_execution_view_result"
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }
is_file_update: boolean
type: "text_editor_code_execution_create_result"
type: "text_editor_code_execution_create_result"
Accepts one of the following:
"text_editor_code_execution_create_result"
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }
lines: array of string
new_lines: number
new_start: number
old_lines: number
old_start: number
type: "text_editor_code_execution_str_replace_result"
type: "text_editor_code_execution_str_replace_result"
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
tool_use_id: string
type: "text_editor_code_execution_tool_result"
type: "text_editor_code_execution_tool_result"
Accepts one of the following:
"text_editor_code_execution_tool_result"
BetaMCPToolUseBlock = object { id, input, name, 2 more }
BetaMCPToolUseBlock = object { id, input, name, 2 more }
id: string
input: map[unknown]
name: string
The name of the MCP tool
server_name: string
The name of the MCP server
type: "mcp_tool_use"
type: "mcp_tool_use"
Accepts one of the following:
"mcp_tool_use"
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }
Accepts one of the following:
UnionMember0 = string
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:
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_char_index: number
file_id: string
start_char_index: number
minimum0
type: "char_location"
type: "char_location"
Accepts one of the following:
"char_location"
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_page_number: number
file_id: string
start_page_number: number
minimum1
type: "page_location"
type: "page_location"
Accepts one of the following:
"page_location"
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }
cited_text: string
document_index: number
minimum0
document_title: string
end_block_index: number
file_id: string
start_block_index: number
minimum0
type: "content_block_location"
type: "content_block_location"
Accepts one of the following:
"content_block_location"
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }
cited_text: string
encrypted_index: string
title: string
maxLength512
type: "web_search_result_location"
type: "web_search_result_location"
Accepts one of the following:
"web_search_result_location"
url: string
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }
cited_text: string
end_block_index: number
search_result_index: number
minimum0
source: string
start_block_index: number
minimum0
title: string
type: "search_result_location"
type: "search_result_location"
Accepts one of the following:
"search_result_location"
text: string
maxLength5000000
minLength0
type: "text"
type: "text"
Accepts one of the following:
"text"
is_error: boolean
tool_use_id: string
type: "mcp_tool_result"
type: "mcp_tool_result"
Accepts one of the following:
"mcp_tool_result"
BetaContainerUploadBlock = object { file_id, type } Response model for a file uploaded to the container.
BetaContainerUploadBlock = object { file_id, type }
Response model for a file uploaded to the container.
file_id: string
type: "container_upload"
type: "container_upload"
Accepts one of the following:
"container_upload"
Context management response.
Information about context management strategies applied during the request.
Context management response.
Information about context management strategies applied during the request.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } List of context management edits that were applied.
applied_edits: array of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }
List of context management edits that were applied.
Accepts one of the following:
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_tool_uses: number
Number of tool uses that were cleared.
minimum0
type: "clear_tool_uses_20250919"The type of context management edit applied.
type: "clear_tool_uses_20250919"
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }
cleared_input_tokens: number
Number of input tokens cleared by this edit.
minimum0
cleared_thinking_turns: number
Number of thinking turns that were cleared.
minimum0
type: "clear_thinking_20251015"The type of context management edit applied.
type: "clear_thinking_20251015"
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 moreThe model that will complete your prompt.
See models for additional details and options.
UnionMember0 = "claude-3-7-sonnet-latest" or "claude-3-7-sonnet-20250219" or "claude-3-5-haiku-latest" or 15 more
The model that will complete your prompt.
See models for additional details and options.
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 = string
role: "assistant"Conversational role of the generated message.
This will always be "assistant".
role: "assistant"
Conversational role of the generated message.
This will always be "assistant".
Accepts one of the following:
"assistant"
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.
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: string
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: "message"Object type.
For Messages, this is always "message".
type: "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.
Breakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
minimum0
cache_creation_input_tokens: number
The number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
minimum0
input_tokens: number
The number of input tokens which were used.
minimum0
output_tokens: number
The number of output tokens which were used.
minimum0
The number of server tool requests.
The number of server tool requests.
web_fetch_requests: number
The number of web fetch tool requests.
minimum0
web_search_requests: number
The number of web search tool requests.
minimum0
service_tier: "standard" or "priority" or "batch"If the request used the priority, standard, or batch tier.
service_tier: "standard" or "priority" or "batch"
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: "succeeded"
type: "succeeded"
Accepts one of the following:
"succeeded"
BetaModels
List Models
get/v1/models?beta=true
Get a Model
get/v1/models/{model_id}?beta=true
ModelsExpand Collapse
BetaModelInfo = object { id, created_at, display_name, type }
BetaModelInfo = object { id, created_at, display_name, type }
id: string
Unique model identifier.
created_at: string
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: string
A human-readable name for the model.
type: "model"Object type.
For Models, this is always "model".
type: "model"
Object type.
For Models, this is always "model".
Accepts one of the following:
"model"
BetaSkills
Create Skill
post/v1/skills?beta=true
Delete Skill
delete/v1/skills/{skill_id}?beta=true
List Skills
get/v1/skills?beta=true
Get Skill
get/v1/skills/{skill_id}?beta=true
BetaSkillsVersions
Create Skill Version
post/v1/skills/{skill_id}/versions?beta=true
Delete Skill Version
delete/v1/skills/{skill_id}/versions/{version}?beta=true
List Skill Versions
get/v1/skills/{skill_id}/versions?beta=true
Get Skill Version
get/v1/skills/{skill_id}/versions/{version}?beta=true