Beta

ModelsExpand Collapse

AnthropicBeta = String | :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 15 more

Accepts one of the following:

String

:"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 15 more

Accepts one of the following:

:"message-batches-2024-09-24"

:"prompt-caching-2024-07-31"

:"computer-use-2024-10-22"

:"computer-use-2025-01-24"

:"pdfs-2024-09-25"

:"token-counting-2024-11-01"

:"token-efficient-tools-2025-02-19"

:"output-128k-2025-02-19"

:"files-api-2025-04-14"

:"mcp-client-2025-04-04"

:"dev-full-thinking-2025-05-14"

:"interleaved-thinking-2025-05-14"

:"code-execution-2025-05-22"

:"extended-cache-ttl-2025-04-11"

:"context-1m-2025-08-07"

:"context-management-2025-06-27"

:"model-context-window-exceeded-2025-08-26"

:"skills-2025-10-02"

class BetaAPIError { message, type }

message: String

type: :api_error

Accepts one of the following:

:api_error

class BetaAuthenticationError { message, type }

message: String

type: :authentication_error

Accepts one of the following:

:authentication_error

class BetaBillingError { message, type }

message: String

type: :billing_error

Accepts one of the following:

:billing_error

BetaError = BetaInvalidRequestError { message, type } | BetaAuthenticationError { message, type } | BetaBillingError { message, type } | 6 more

Accepts one of the following:

class BetaInvalidRequestError { message, type }

message: String

type: :invalid_request_error

Accepts one of the following:

:invalid_request_error

class BetaAuthenticationError { message, type }

message: String

type: :authentication_error

Accepts one of the following:

:authentication_error

class BetaBillingError { message, type }

message: String

type: :billing_error

Accepts one of the following:

:billing_error

class BetaPermissionError { message, type }

message: String

type: :permission_error

Accepts one of the following:

:permission_error

class BetaNotFoundError { message, type }

message: String

type: :not_found_error

Accepts one of the following:

:not_found_error

class BetaRateLimitError { message, type }

message: String

type: :rate_limit_error

Accepts one of the following:

:rate_limit_error

class BetaGatewayTimeoutError { message, type }

message: String

type: :timeout_error

Accepts one of the following:

:timeout_error

class BetaAPIError { message, type }

message: String

type: :api_error

Accepts one of the following:

:api_error

class BetaOverloadedError { message, type }

message: String

type: :overloaded_error

Accepts one of the following:

:overloaded_error

class BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError { message, type }

message: String

type: :invalid_request_error

Accepts one of the following:

:invalid_request_error

class BetaAuthenticationError { message, type }

message: String

type: :authentication_error

Accepts one of the following:

:authentication_error

class BetaBillingError { message, type }

message: String

type: :billing_error

Accepts one of the following:

:billing_error

class BetaPermissionError { message, type }

message: String

type: :permission_error

Accepts one of the following:

:permission_error

class BetaNotFoundError { message, type }

message: String

type: :not_found_error

Accepts one of the following:

:not_found_error

class BetaRateLimitError { message, type }

message: String

type: :rate_limit_error

Accepts one of the following:

:rate_limit_error

class BetaGatewayTimeoutError { message, type }

message: String

type: :timeout_error

Accepts one of the following:

:timeout_error

class BetaAPIError { message, type }

message: String

type: :api_error

Accepts one of the following:

:api_error

class BetaOverloadedError { message, type }

message: String

type: :overloaded_error

Accepts one of the following:

:overloaded_error

request_id: String

type: :error

Accepts one of the following:

:error

class BetaGatewayTimeoutError { message, type }

message: String

type: :timeout_error

Accepts one of the following:

:timeout_error

class BetaInvalidRequestError { message, type }

message: String

type: :invalid_request_error

Accepts one of the following:

:invalid_request_error

class BetaNotFoundError { message, type }

message: String

type: :not_found_error

Accepts one of the following:

:not_found_error

class BetaOverloadedError { message, type }

message: String

type: :overloaded_error

Accepts one of the following:

:overloaded_error

class BetaPermissionError { message, type }

message: String

type: :permission_error

Accepts one of the following:

:permission_error

class BetaRateLimitError { message, type }

message: String

type: :rate_limit_error

Accepts one of the following:

:rate_limit_error

BetaFiles

Delete File

beta.files.delete(file_id, **kwargs) -> DeletedFile { id, type }

delete/v1/files/{file_id}?beta=true

Download File

beta.files.download(file_id, **kwargs) -> StringIO

get/v1/files/{file_id}/content?beta=true

List Files

beta.files.list(**kwargs) -> Page<FileMetadata { id, created_at, filename, 4 more } >

get/v1/files?beta=true

Get File Metadata

beta.files.retrieve_metadata(file_id, **kwargs) -> FileMetadata { id, created_at, filename, 4 more }

get/v1/files/{file_id}?beta=true

Upload File

beta.files.upload(**kwargs) -> FileMetadata { id, created_at, filename, 4 more }

post/v1/files?beta=true

ModelsExpand Collapse

class DeletedFile { id, type }

id: String

ID of the deleted file.

type: :file_deleted

Deleted object type.

For file deletion, this is always "file_deleted".

Accepts one of the following:

:file_deleted

class FileMetadata { id, created_at, filename, 4 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

created_at: Time

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

Size of the file in bytes.

minimum0

type: :file

Object type.

For files, this is always "file".

Accepts one of the following:

:file

downloadable: bool

Whether the file can be downloaded.

BetaMessages

Count tokens in a Message

beta.messages.count_tokens(**kwargs) -> BetaMessageTokensCount { context_management, input_tokens }

post/v1/messages/count_tokens?beta=true

Create a Message

beta.messages.create(**kwargs) -> BetaMessage { id, container, content, 7 more }

post/v1/messages?beta=true

ModelsExpand Collapse

class BetaAllThinkingTurns { type }

type: :all

Accepts one of the following:

:all

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaBashCodeExecutionOutputBlock { file_id, type }

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

class BetaBashCodeExecutionOutputBlockParam { file_id, type }

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultErrorParam { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionToolResultErrorParam { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaCacheControlEphemeral { type, ttl }

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationConfig { enabled }

enabled: bool

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationsConfigParam { enabled }

enabled: bool

class BetaCitationsDelta { citation, type }

citation: BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

type: :citations_delta

Accepts one of the following:

:citations_delta

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaClearThinking20251015Edit { type, keep }

type: :clear_thinking_20251015

Accepts one of the following:

:clear_thinking_20251015

keep: BetaThinkingTurns { type, value } | BetaAllThinkingTurns { type } | :all

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

Accepts one of the following:

class BetaThinkingTurns { type, value }

type: :thinking_turns

Accepts one of the following:

:thinking_turns

value: Integer

minimum1

class BetaAllThinkingTurns { type }

type: :all

Accepts one of the following:

:all

Keep = :all

Accepts one of the following:

:all

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

class BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }

type: :clear_tool_uses_20250919

Accepts one of the following:

:clear_tool_uses_20250919

clear_at_least: BetaInputTokensClearAtLeast { type, value }

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

Accepts one of the following:

:input_tokens

value: Integer

minimum0

clear_tool_inputs: bool | Array[String]

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

Accepts one of the following:

bool

Array[String]

exclude_tools: Array[String]

Tool names whose uses are preserved from clearing

keep: BetaToolUsesKeep { type, value }

Number of tool uses to retain in the conversation

type: :tool_uses

Accepts one of the following:

:tool_uses

value: Integer

minimum0

trigger: BetaInputTokensTrigger { type, value } | BetaToolUsesTrigger { type, value }

Condition that triggers the context management strategy

Accepts one of the following:

class BetaInputTokensTrigger { type, value }

type: :input_tokens

Accepts one of the following:

:input_tokens

value: Integer

minimum1

class BetaToolUsesTrigger { type, value }

type: :tool_uses

Accepts one of the following:

:tool_uses

value: Integer

minimum1

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaCodeExecutionOutputBlock { file_id, type }

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

class BetaCodeExecutionOutputBlockParam { file_id, type }

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

class BetaCodeExecutionTool20250522 { name, type, cache_control }

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

Accepts one of the following:

:code_execution_20250522

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCodeExecutionTool20250825 { name, type, cache_control }

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

Accepts one of the following:

:code_execution_20250825

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

BetaCodeExecutionToolResultBlockContent = BetaCodeExecutionToolResultError { error_code, type } | BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

class BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaCodeExecutionToolResultBlockParamContent

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultErrorParam { error_code, type } | BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

BetaCodeExecutionToolResultErrorCode = :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

class BetaCodeExecutionToolResultErrorParam { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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

class BetaContainerParams { id, skills }

Container parameters with skills to be loaded.

id: String

Container id

skills: Array[BetaSkillParams { skill_id, type, version } ]

List of skills to load in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

class BetaContainerUploadBlockParam { 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

Accepts one of the following:

:container_upload

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

BetaContentBlock = BetaTextBlock { citations, text, type } | BetaThinkingBlock { signature, thinking, type } | BetaRedactedThinkingBlock { data, type } | 10 more

Response model for a file uploaded to the container.

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

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

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type } | BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

BetaContentBlockParam = BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaRequestDocumentBlock { source, type, cache_control, 3 more } | 14 more

Regular text content.

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

class BetaSearchResultBlockParam { content, source, title, 3 more }

content: Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

source: String

title: String

type: :search_result

Accepts one of the following:

:search_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

class BetaThinkingBlockParam { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlockParam { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlockParam { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

maxLength200

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: String

type: :tool_result

Accepts one of the following:

:tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | BetaRequestDocumentBlock { source, type, cache_control, 3 more } ]

Accepts one of the following:

String

Array[BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control } | BetaSearchResultBlockParam { content, source, title, 3 more } | BetaRequestDocumentBlock { source, type, cache_control, 3 more } ]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaSearchResultBlockParam { content, source, title, 3 more }

content: Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

source: String

title: String

type: :search_result

Accepts one of the following:

:search_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

class BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

is_error: bool

class BetaServerToolUseBlockParam { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaWebSearchToolResultBlockParamContent

Accepts one of the following:

Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]

encrypted_content: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

page_age: String

class BetaWebSearchToolRequestError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

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

Accepts one of the following:

:web_search_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlockParam { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlockParam { content, type, url, retrieved_at }

content: BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

type: :web_fetch_result

Accepts one of the following:

:web_fetch_result

url: String

Fetched content URL

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

tool_use_id: String

type: :web_fetch_tool_result

Accepts one of the following:

:web_fetch_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaCodeExecutionToolResultBlockParamContent

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultErrorParam { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

error_message: String

class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

num_lines: Integer

start_line: Integer

total_lines: Integer

class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

type: :text_editor_code_execution_str_replace_result

Accepts one of the following:

:text_editor_code_execution_str_replace_result

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

tool_use_id: String

type: :text_editor_code_execution_tool_result

Accepts one of the following:

:text_editor_code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaMCPToolUseBlockParam { id, input, name, 3 more }

id: String

input: Hash[Symbol, untyped]

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } ]

Accepts one of the following:

String

Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

is_error: bool

class BetaContainerUploadBlockParam { 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

Accepts one of the following:

:container_upload

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

BetaContentBlockSourceContent = BetaTextBlockParam { text, type, cache_control, citations } | BetaImageBlockParam { source, type, cache_control }

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaContextManagementConfig { edits }

edits: Array[BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more } | BetaClearThinking20251015Edit { type, keep } ]

List of context management edits to apply

Accepts one of the following:

class BetaClearToolUses20250919Edit { type, clear_at_least, clear_tool_inputs, 3 more }

type: :clear_tool_uses_20250919

Accepts one of the following:

:clear_tool_uses_20250919

clear_at_least: BetaInputTokensClearAtLeast { type, value }

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

Accepts one of the following:

:input_tokens

value: Integer

minimum0

clear_tool_inputs: bool | Array[String]

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

Accepts one of the following:

bool

Array[String]

exclude_tools: Array[String]

Tool names whose uses are preserved from clearing

keep: BetaToolUsesKeep { type, value }

Number of tool uses to retain in the conversation

type: :tool_uses

Accepts one of the following:

:tool_uses

value: Integer

minimum0

trigger: BetaInputTokensTrigger { type, value } | BetaToolUsesTrigger { type, value }

Condition that triggers the context management strategy

Accepts one of the following:

class BetaInputTokensTrigger { type, value }

type: :input_tokens

Accepts one of the following:

:input_tokens

value: Integer

minimum1

class BetaToolUsesTrigger { type, value }

type: :tool_uses

Accepts one of the following:

:tool_uses

value: Integer

minimum1

class BetaClearThinking20251015Edit { type, keep }

type: :clear_thinking_20251015

Accepts one of the following:

:clear_thinking_20251015

keep: BetaThinkingTurns { type, value } | BetaAllThinkingTurns { type } | :all

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

Accepts one of the following:

class BetaThinkingTurns { type, value }

type: :thinking_turns

Accepts one of the following:

:thinking_turns

value: Integer

minimum1

class BetaAllThinkingTurns { type }

type: :all

Accepts one of the following:

:all

Keep = :all

Accepts one of the following:

:all

class BetaContextManagementResponse { applied_edits }

applied_edits: Array[BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } | BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type } ]

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

class BetaCountTokensContextManagementResponse { original_input_tokens }

original_input_tokens: Integer

The original token count before context management was applied

class BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaInputJSONDelta { partial_json, type }

partial_json: String

type: :input_json_delta

Accepts one of the following:

:input_json_delta

class BetaInputTokensClearAtLeast { type, value }

type: :input_tokens

Accepts one of the following:

:input_tokens

value: Integer

minimum0

class BetaInputTokensTrigger { type, value }

type: :input_tokens

Accepts one of the following:

:input_tokens

value: Integer

minimum1

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolUseBlockParam { id, input, name, 3 more }

id: String

input: Hash[Symbol, untyped]

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaMemoryTool20250818 { name, type, cache_control }

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

Accepts one of the following:

:memory_20250818

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

BetaMemoryTool20250818Command = BetaMemoryTool20250818ViewCommand { command, path, view_range } | BetaMemoryTool20250818CreateCommand { command, file_text, path } | BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path } | 3 more

Accepts one of the following:

class BetaMemoryTool20250818ViewCommand { command, path, view_range }

command: :view

Command type identifier

Accepts one of the following:

:view

path: String

Path to directory or file to view

view_range: Array[Integer]

Optional line range for viewing specific lines

class BetaMemoryTool20250818CreateCommand { command, file_text, path }

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

class BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path }

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

class BetaMemoryTool20250818InsertCommand { command, insert_line, insert_text, path }

command: :insert

Command type identifier

Accepts one of the following:

:insert

insert_line: Integer

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

class BetaMemoryTool20250818DeleteCommand { command, path }

command: :delete

Command type identifier

Accepts one of the following:

:delete

path: String

Path to the file or directory to delete

class BetaMemoryTool20250818RenameCommand { command, new_path, old_path }

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

class BetaMemoryTool20250818CreateCommand { command, file_text, path }

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

class BetaMemoryTool20250818DeleteCommand { command, path }

command: :delete

Command type identifier

Accepts one of the following:

:delete

path: String

Path to the file or directory to delete

class BetaMemoryTool20250818InsertCommand { command, insert_line, insert_text, path }

command: :insert

Command type identifier

Accepts one of the following:

:insert

insert_line: Integer

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

class BetaMemoryTool20250818RenameCommand { command, new_path, old_path }

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

class BetaMemoryTool20250818StrReplaceCommand { command, new_str, old_str, path }

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

class BetaMemoryTool20250818ViewCommand { command, path, view_range }

command: :view

Command type identifier

Accepts one of the following:

:view

path: String

Path to directory or file to view

view_range: Array[Integer]

Optional line range for viewing specific lines

class BetaMessage { id, container, content, 7 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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: Array[BetaContentBlock]

Content generated by the model.

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

Example:

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

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

For example, if the input messages were:

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

Then the response content might be:

[{"type": "text", "text": "B)"}]

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

context_management: BetaContextManagementResponse { applied_edits }

Context management response.

Information about context management strategies applied during the request.

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 more

The model that will complete your prompt.

See models for additional details and options.

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

String

role: :assistant

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

:assistant

stop_reason: BetaStopReason

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

stop_sequence: 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".

Accepts one of the following:

:message

usage: BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 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: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

class BetaMessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The cumulative number of input tokens read from the cache.

minimum0

input_tokens: Integer

The cumulative number of input tokens which were used.

minimum0

output_tokens: Integer

The cumulative number of output tokens which were used.

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

class BetaMessageParam { content, role }

content: String | Array[BetaContentBlockParam]

Accepts one of the following:

String

Array[BetaContentBlockParam]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

class BetaSearchResultBlockParam { content, source, title, 3 more }

content: Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

source: String

title: String

type: :search_result

Accepts one of the following:

:search_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

class BetaThinkingBlockParam { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlockParam { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlockParam { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

maxLength200

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: String

type: :tool_result

Accepts one of the following:

:tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaSearchResultBlockParam { content, source, title, 3 more }

content: Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

source: String

title: String

type: :search_result

Accepts one of the following:

:search_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

class BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

is_error: bool

class BetaServerToolUseBlockParam { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaWebSearchToolResultBlockParamContent

Accepts one of the following:

Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]

encrypted_content: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

page_age: String

class BetaWebSearchToolRequestError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

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

Accepts one of the following:

:web_search_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlockParam { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlockParam { content, type, url, retrieved_at }

content: BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

type: :web_fetch_result

Accepts one of the following:

:web_fetch_result

url: String

Fetched content URL

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

tool_use_id: String

type: :web_fetch_tool_result

Accepts one of the following:

:web_fetch_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaCodeExecutionToolResultBlockParamContent

Accepts one of the following:

class BetaCodeExecutionToolResultErrorParam { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaBashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaBashCodeExecutionToolResultErrorParam { error_code, type } | BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultErrorParam { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlockParam { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

error_message: String

class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

num_lines: Integer

start_line: Integer

total_lines: Integer

class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

type: :text_editor_code_execution_str_replace_result

Accepts one of the following:

:text_editor_code_execution_str_replace_result

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

tool_use_id: String

type: :text_editor_code_execution_tool_result

Accepts one of the following:

:text_editor_code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaMCPToolUseBlockParam { id, input, name, 3 more }

id: String

input: Hash[Symbol, untyped]

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } ]

Accepts one of the following:

String

Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

is_error: bool

class BetaContainerUploadBlockParam { 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

Accepts one of the following:

:container_upload

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

role: :user | :assistant

Accepts one of the following:

:user

:assistant

class BetaMessageTokensCount { context_management, input_tokens }

context_management: BetaCountTokensContextManagementResponse { original_input_tokens }

Information about context management applied to the message.

original_input_tokens: Integer

The original token count before context management was applied

input_tokens: Integer

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

class BetaMetadata { user_id }

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

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

BetaRawContentBlockDelta = BetaTextDelta { text, type } | BetaInputJSONDelta { partial_json, type } | BetaCitationsDelta { citation, type } | 2 more

Accepts one of the following:

class BetaTextDelta { text, type }

text: String

type: :text_delta

Accepts one of the following:

:text_delta

class BetaInputJSONDelta { partial_json, type }

partial_json: String

type: :input_json_delta

Accepts one of the following:

:input_json_delta

class BetaCitationsDelta { citation, type }

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

type: :citations_delta

Accepts one of the following:

:citations_delta

class BetaThinkingDelta { thinking, type }

thinking: String

type: :thinking_delta

Accepts one of the following:

:thinking_delta

class BetaSignatureDelta { signature, type }

signature: String

type: :signature_delta

Accepts one of the following:

:signature_delta

class BetaRawContentBlockDeltaEvent { delta, index, type }

delta: BetaRawContentBlockDelta

Accepts one of the following:

class BetaTextDelta { text, type }

text: String

type: :text_delta

Accepts one of the following:

:text_delta

class BetaInputJSONDelta { partial_json, type }

partial_json: String

type: :input_json_delta

Accepts one of the following:

:input_json_delta

class BetaCitationsDelta { citation, type }

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

type: :citations_delta

Accepts one of the following:

:citations_delta

class BetaThinkingDelta { thinking, type }

thinking: String

type: :thinking_delta

Accepts one of the following:

:thinking_delta

class BetaSignatureDelta { signature, type }

signature: String

type: :signature_delta

Accepts one of the following:

:signature_delta

index: Integer

type: :content_block_delta

Accepts one of the following:

:content_block_delta

class BetaRawContentBlockStartEvent { content_block, index, type }

content_block: BetaTextBlock { citations, text, type } | BetaThinkingBlock { signature, thinking, type } | BetaRedactedThinkingBlock { data, type } | 10 more

Response model for a file uploaded to the container.

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

index: Integer

type: :content_block_start

Accepts one of the following:

:content_block_start

class BetaRawContentBlockStopEvent { index, type }

index: Integer

type: :content_block_stop

Accepts one of the following:

:content_block_stop

class BetaRawMessageDeltaEvent { context_management, delta, type, usage }

context_management: BetaContextManagementResponse { applied_edits }

Information about context management strategies applied during the request

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

delta: { container, stop_reason, stop_sequence}

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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

stop_reason: BetaStopReason

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

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.

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

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

minimum0

cache_read_input_tokens: Integer

The cumulative number of input tokens read from the cache.

minimum0

input_tokens: Integer

The cumulative number of input tokens which were used.

minimum0

output_tokens: Integer

The cumulative number of output tokens which were used.

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

class BetaRawMessageStartEvent { message, type }

message: BetaMessage { id, container, content, 7 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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: Array[BetaContentBlock]

Content generated by the model.

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

Example:

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

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

For example, if the input messages were:

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

Then the response content might be:

[{"type": "text", "text": "B)"}]

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

context_management: BetaContextManagementResponse { applied_edits }

Context management response.

Information about context management strategies applied during the request.

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 more

The model that will complete your prompt.

See models for additional details and options.

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

String

role: :assistant

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

:assistant

stop_reason: BetaStopReason

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

stop_sequence: 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".

Accepts one of the following:

:message

usage: BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 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.

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: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

type: :message_start

Accepts one of the following:

:message_start

class BetaRawMessageStopEvent { type }

type: :message_stop

Accepts one of the following:

:message_stop

BetaRawMessageStreamEvent = BetaRawMessageStartEvent { message, type } | BetaRawMessageDeltaEvent { context_management, delta, type, usage } | BetaRawMessageStopEvent { type } | 3 more

Accepts one of the following:

class BetaRawMessageStartEvent { message, type }

message: BetaMessage { id, container, content, 7 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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: Array[BetaContentBlock]

Content generated by the model.

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

Example:

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

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

For example, if the input messages were:

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

Then the response content might be:

[{"type": "text", "text": "B)"}]

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

context_management: BetaContextManagementResponse { applied_edits }

Context management response.

Information about context management strategies applied during the request.

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 more

The model that will complete your prompt.

See models for additional details and options.

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

String

role: :assistant

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

:assistant

stop_reason: BetaStopReason

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

stop_sequence: 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".

Accepts one of the following:

:message

usage: BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 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.

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: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

type: :message_start

Accepts one of the following:

:message_start

class BetaRawMessageDeltaEvent { context_management, delta, type, usage }

context_management: BetaContextManagementResponse { applied_edits }

Information about context management strategies applied during the request

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

delta: { container, stop_reason, stop_sequence}

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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

stop_reason: BetaStopReason

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

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.

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

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

minimum0

cache_read_input_tokens: Integer

The cumulative number of input tokens read from the cache.

minimum0

input_tokens: Integer

The cumulative number of input tokens which were used.

minimum0

output_tokens: Integer

The cumulative number of output tokens which were used.

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

class BetaRawMessageStopEvent { type }

type: :message_stop

Accepts one of the following:

:message_stop

class BetaRawContentBlockStartEvent { content_block, index, type }

content_block: BetaTextBlock { citations, text, type } | BetaThinkingBlock { signature, thinking, type } | BetaRedactedThinkingBlock { data, type } | 10 more

Response model for a file uploaded to the container.

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

index: Integer

type: :content_block_start

Accepts one of the following:

:content_block_start

class BetaRawContentBlockDeltaEvent { delta, index, type }

delta: BetaRawContentBlockDelta

Accepts one of the following:

class BetaTextDelta { text, type }

text: String

type: :text_delta

Accepts one of the following:

:text_delta

class BetaInputJSONDelta { partial_json, type }

partial_json: String

type: :input_json_delta

Accepts one of the following:

:input_json_delta

class BetaCitationsDelta { citation, type }

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

type: :citations_delta

Accepts one of the following:

:citations_delta

class BetaThinkingDelta { thinking, type }

thinking: String

type: :thinking_delta

Accepts one of the following:

:thinking_delta

class BetaSignatureDelta { signature, type }

signature: String

type: :signature_delta

Accepts one of the following:

:signature_delta

index: Integer

type: :content_block_delta

Accepts one of the following:

:content_block_delta

class BetaRawContentBlockStopEvent { index, type }

index: Integer

type: :content_block_stop

Accepts one of the following:

:content_block_stop

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaRedactedThinkingBlockParam { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

class BetaRequestMCPServerToolConfiguration { allowed_tools, enabled }

allowed_tools: Array[String]

enabled: bool

class BetaRequestMCPServerURLDefinition { name, type, url, 2 more }

type: :url

Accepts one of the following:

:url

url: String

authorization_token: String

tool_configuration: BetaRequestMCPServerToolConfiguration { allowed_tools, enabled }

allowed_tools: Array[String]

enabled: bool

class BetaRequestMCPToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

content: String | Array[BetaTextBlockParam { text, type, cache_control, citations } ]

Accepts one of the following:

String

Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

is_error: bool

class BetaSearchResultBlockParam { content, source, title, 3 more }

content: Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

source: String

title: String

type: :search_result

Accepts one of the following:

:search_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

class BetaServerToolUsage { web_fetch_requests, web_search_requests }

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaServerToolUseBlockParam { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaSignatureDelta { signature, type }

signature: String

type: :signature_delta

Accepts one of the following:

:signature_delta

class BetaSkill { skill_id, type, version }

A skill that was loaded in a container (response model).

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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

class BetaSkillParams { 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 | :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

BetaStopReason = :end_turn | :max_tokens | :stop_sequence | 4 more

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

BetaTextCitation = BetaCitationCharLocation { cited_text, document_index, document_title, 4 more } | BetaCitationPageLocation { cited_text, document_index, document_title, 4 more } | BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

BetaTextCitationParam = BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more } | BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more } | BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more } | 2 more

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaTextDelta { text, type }

text: String

type: :text_delta

Accepts one of the following:

:text_delta

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

type: :text_editor_code_execution_str_replace_result

Accepts one of the following:

:text_editor_code_execution_str_replace_result

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

type: :text_editor_code_execution_str_replace_result

Accepts one of the following:

:text_editor_code_execution_str_replace_result

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

error_message: String

class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

num_lines: Integer

start_line: Integer

total_lines: Integer

class BetaTextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

type: :text_editor_code_execution_str_replace_result

Accepts one of the following:

:text_editor_code_execution_str_replace_result

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

tool_use_id: String

type: :text_editor_code_execution_tool_result

Accepts one of the following:

:text_editor_code_execution_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

error_message: String

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

num_lines: Integer

start_line: Integer

total_lines: Integer

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaThinkingBlockParam { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaThinkingConfigDisabled { type }

type: :disabled

Accepts one of the following:

:disabled

class BetaThinkingConfigEnabled { budget_tokens, type }

budget_tokens: Integer

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

Accepts one of the following:

:enabled

BetaThinkingConfigParam = BetaThinkingConfigEnabled { budget_tokens, type } | 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:

class BetaThinkingConfigEnabled { budget_tokens, type }

budget_tokens: Integer

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

Accepts one of the following:

:enabled

class BetaThinkingConfigDisabled { type }

type: :disabled

Accepts one of the following:

:disabled

class BetaThinkingDelta { thinking, type }

thinking: String

type: :thinking_delta

Accepts one of the following:

:thinking_delta

class BetaThinkingTurns { type, value }

type: :thinking_turns

Accepts one of the following:

:thinking_turns

value: Integer

minimum1

class BetaTool { input_schema, name, cache_control, 2 more }

input_schema: { 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

Accepts one of the following:

:object

properties: Hash[Symbol, untyped]

required: Array[String]

Name of the tool.

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

maxLength128

minLength1

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

description: 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: :custom

Accepts one of the following:

:custom

class BetaToolBash20241022 { name, type, cache_control }

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

Accepts one of the following:

:bash_20241022

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolBash20250124 { name, type, cache_control }

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

Accepts one of the following:

:bash_20250124

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

BetaToolChoice = BetaToolChoiceAuto { type, disable_parallel_tool_use } | BetaToolChoiceAny { type, disable_parallel_tool_use } | BetaToolChoiceTool { name, type, disable_parallel_tool_use } | 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:

class BetaToolChoiceAuto { type, disable_parallel_tool_use }

The model will automatically decide whether to use tools.

type: :auto

Accepts one of the following:

:auto

disable_parallel_tool_use: bool

Whether to disable parallel tool use.

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

class BetaToolChoiceAny { type, disable_parallel_tool_use }

The model will use any available tools.

type: :any

Accepts one of the following:

:any

disable_parallel_tool_use: bool

Whether to disable parallel tool use.

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

class BetaToolChoiceTool { name, type, disable_parallel_tool_use }

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

The name of the tool to use.

type: :tool

Accepts one of the following:

:tool

disable_parallel_tool_use: bool

Whether to disable parallel tool use.

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

class BetaToolChoiceNone { type }

The model will not be allowed to use tools.

type: :none

Accepts one of the following:

:none

class BetaToolChoiceAny { type, disable_parallel_tool_use }

The model will use any available tools.

type: :any

Accepts one of the following:

:any

disable_parallel_tool_use: bool

Whether to disable parallel tool use.

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

class BetaToolChoiceAuto { type, disable_parallel_tool_use }

The model will automatically decide whether to use tools.

type: :auto

Accepts one of the following:

:auto

disable_parallel_tool_use: bool

Whether to disable parallel tool use.

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

class BetaToolChoiceNone { type }

The model will not be allowed to use tools.

type: :none

Accepts one of the following:

:none

class BetaToolChoiceTool { name, type, disable_parallel_tool_use }

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

The name of the tool to use.

type: :tool

Accepts one of the following:

:tool

disable_parallel_tool_use: bool

Whether to disable parallel tool use.

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

class BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 3 more }

display_height_px: Integer

The height of the display in pixels.

minimum1

display_width_px: Integer

The width of the display in pixels.

minimum1

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

Accepts one of the following:

:computer_20241022

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

display_number: Integer

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 3 more }

display_height_px: Integer

The height of the display in pixels.

minimum1

display_width_px: Integer

The width of the display in pixels.

minimum1

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

Accepts one of the following:

:computer_20250124

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

display_number: Integer

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: String

type: :tool_result

Accepts one of the following:

:tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

Accepts one of the following:

String

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaSearchResultBlockParam { content, source, title, 3 more }

content: Array[BetaTextBlockParam { text, type, cache_control, citations } ]

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

source: String

title: String

type: :search_result

Accepts one of the following:

:search_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

class BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

is_error: bool

class BetaToolTextEditor20241022 { name, type, cache_control }

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

Accepts one of the following:

:text_editor_20241022

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolTextEditor20250124 { name, type, cache_control }

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

Accepts one of the following:

:text_editor_20250124

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolTextEditor20250429 { name, type, cache_control }

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

Accepts one of the following:

:text_editor_20250429

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolTextEditor20250728 { name, type, cache_control, max_characters }

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

Accepts one of the following:

:text_editor_20250728

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

max_characters: Integer

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 } | BetaToolBash20241022 { name, type, cache_control } | BetaToolBash20250124 { name, type, cache_control } | 11 more

Accepts one of the following:

class BetaTool { input_schema, name, cache_control, 2 more }

input_schema: { 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

Accepts one of the following:

:object

properties: Hash[Symbol, untyped]

required: Array[String]

Name of the tool.

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

maxLength128

minLength1

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

description: String

Description of what this tool does.

type: :custom

Accepts one of the following:

:custom

class BetaToolBash20241022 { name, type, cache_control }

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

Accepts one of the following:

:bash_20241022

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolBash20250124 { name, type, cache_control }

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

Accepts one of the following:

:bash_20250124

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCodeExecutionTool20250522 { name, type, cache_control }

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

Accepts one of the following:

:code_execution_20250522

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaCodeExecutionTool20250825 { name, type, cache_control }

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

Accepts one of the following:

:code_execution_20250825

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolComputerUse20241022 { display_height_px, display_width_px, name, 3 more }

display_height_px: Integer

The height of the display in pixels.

minimum1

display_width_px: Integer

The width of the display in pixels.

minimum1

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

Accepts one of the following:

:computer_20241022

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

display_number: Integer

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaMemoryTool20250818 { name, type, cache_control }

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

Accepts one of the following:

:memory_20250818

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolComputerUse20250124 { display_height_px, display_width_px, name, 3 more }

display_height_px: Integer

The height of the display in pixels.

minimum1

display_width_px: Integer

The width of the display in pixels.

minimum1

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

Accepts one of the following:

:computer_20250124

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

display_number: Integer

The X11 display number (e.g. 0, 1) for the display.

minimum0

class BetaToolTextEditor20241022 { name, type, cache_control }

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

Accepts one of the following:

:text_editor_20241022

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolTextEditor20250124 { name, type, cache_control }

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

Accepts one of the following:

:text_editor_20250124

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolTextEditor20250429 { name, type, cache_control }

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

Accepts one of the following:

:text_editor_20250429

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolTextEditor20250728 { name, type, cache_control, max_characters }

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

Accepts one of the following:

:text_editor_20250728

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

max_characters: Integer

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

minimum1

class BetaWebSearchTool20250305 { name, type, allowed_domains, 4 more }

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

Accepts one of the following:

:web_search_20250305

allowed_domains: Array[String]

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

blocked_domains: Array[String]

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

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

max_uses: Integer

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

exclusiveMinimum0

user_location: { type, city, country, 2 more}

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

type: :approximate

Accepts one of the following:

:approximate

city: String

The city of the user.

maxLength255

minLength1

country: String

The two letter ISO country code of the user.

maxLength2

minLength2

region: String

The region of the user.

maxLength255

minLength1

timezone: String

The IANA timezone of the user.

maxLength255

minLength1

class BetaWebFetchTool20250910 { name, type, allowed_domains, 5 more }

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

Accepts one of the following:

:web_fetch_20250910

allowed_domains: Array[String]

List of domains to allow fetching from

blocked_domains: Array[String]

List of domains to block fetching from

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

Citations configuration for fetched documents. Citations are disabled by default.

enabled: bool

max_content_tokens: Integer

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

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

exclusiveMinimum0

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaToolUseBlockParam { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

maxLength200

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaToolUsesKeep { type, value }

type: :tool_uses

Accepts one of the following:

:tool_uses

value: Integer

minimum0

class BetaToolUsesTrigger { type, value }

type: :tool_uses

Accepts one of the following:

:tool_uses

value: Integer

minimum1

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }

cache_creation: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

type: :web_fetch_result

Accepts one of the following:

:web_fetch_result

url: String

Fetched content URL

class BetaWebFetchBlockParam { content, type, url, retrieved_at }

content: BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

type: :web_fetch_result

Accepts one of the following:

:web_fetch_result

url: String

Fetched content URL

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

class BetaWebFetchTool20250910 { name, type, allowed_domains, 5 more }

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

Accepts one of the following:

:web_fetch_20250910

allowed_domains: Array[String]

List of domains to allow fetching from

blocked_domains: Array[String]

List of domains to block fetching from

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

Citations configuration for fetched documents. Citations are disabled by default.

enabled: bool

max_content_tokens: Integer

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

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

exclusiveMinimum0

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaWebFetchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaWebFetchToolResultErrorBlockParam { error_code, type } | BetaWebFetchBlockParam { content, type, url, retrieved_at }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlockParam { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlockParam { content, type, url, retrieved_at }

content: BetaRequestDocumentBlock { source, type, cache_control, 3 more }

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type } | BetaContentBlockSource { content, type } | 2 more

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

class BetaContentBlockSource { content, type }

content: String | Array[BetaContentBlockSourceContent]

Accepts one of the following:

String

Array[BetaContentBlockSourceContent]

Accepts one of the following:

class BetaTextBlockParam { text, type, cache_control, citations }

text: String

minLength1

type: :text

Accepts one of the following:

:text

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: Array[BetaTextCitationParam]

Accepts one of the following:

class BetaCitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_char_index: Integer

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_page_number: Integer

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

maxLength255

minLength1

end_block_index: Integer

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

minLength1

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

maxLength2048

minLength1

class BetaCitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

class BetaImageBlockParam { source, type, cache_control }

source: BetaBase64ImageSource { data, media_type, type } | BetaURLImageSource { type, url } | BetaFileImageSource { file_id, type }

Accepts one of the following:

class BetaBase64ImageSource { data, media_type, type }

data: String

formatbyte

media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"

Accepts one of the following:

:"image/jpeg"

:"image/png"

:"image/gif"

:"image/webp"

type: :base64

Accepts one of the following:

:base64

class BetaURLImageSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileImageSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :image

Accepts one of the following:

:image

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

type: :content

Accepts one of the following:

:content

class BetaURLPDFSource { type, url }

type: :url

Accepts one of the following:

:url

url: String

class BetaFileDocumentSource { file_id, type }

file_id: String

type: :file

Accepts one of the following:

:file

type: :document

Accepts one of the following:

:document

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

citations: BetaCitationsConfigParam { enabled }

enabled: bool

context: String

minLength1

title: String

maxLength500

minLength1

type: :web_fetch_result

Accepts one of the following:

:web_fetch_result

url: String

Fetched content URL

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

tool_use_id: String

type: :web_fetch_tool_result

Accepts one of the following:

:web_fetch_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchToolResultErrorBlockParam { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

BetaWebFetchToolResultErrorCode = :invalid_tool_input | :url_too_long | :url_not_allowed | 5 more

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

class BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more }

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

class BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more }

encrypted_content: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

page_age: String

class BetaWebSearchTool20250305 { name, type, allowed_domains, 4 more }

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

Accepts one of the following:

:web_search_20250305

allowed_domains: Array[String]

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

blocked_domains: Array[String]

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

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

max_uses: Integer

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

exclusiveMinimum0

user_location: { type, city, country, 2 more}

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

type: :approximate

Accepts one of the following:

:approximate

city: String

The city of the user.

maxLength255

minLength1

country: String

The two letter ISO country code of the user.

maxLength2

minLength2

region: String

The region of the user.

maxLength255

minLength1

timezone: String

The IANA timezone of the user.

maxLength255

minLength1

class BetaWebSearchToolRequestError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

BetaWebSearchToolResultBlockContent = BetaWebSearchToolResultError { error_code, type } | Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

class BetaWebSearchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BetaWebSearchToolResultBlockParamContent

Accepts one of the following:

Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]

encrypted_content: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

page_age: String

class BetaWebSearchToolRequestError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

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

Accepts one of the following:

:web_search_tool_result

cache_control: BetaCacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral

Accepts one of the following:

:ephemeral

ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

5m: 5 minutes
1h: 1 hour

Defaults to 5m.

Accepts one of the following:

:"5m"

:"1h"

BetaWebSearchToolResultBlockParamContent = Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ] | BetaWebSearchToolRequestError { error_code, type }

Accepts one of the following:

Array[BetaWebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]

encrypted_content: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

page_age: String

class BetaWebSearchToolRequestError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

BetaWebSearchToolResultErrorCode = :invalid_tool_input | :unavailable | :max_uses_exceeded | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

BetaMessagesBatches

Cancel a Message Batch

beta.messages.batches.cancel(message_batch_id, **kwargs) -> BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more }

post/v1/messages/batches/{message_batch_id}/cancel?beta=true

Create a Message Batch

beta.messages.batches.create(**kwargs) -> BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more }

post/v1/messages/batches?beta=true

Delete a Message Batch

beta.messages.batches.delete(message_batch_id, **kwargs) -> BetaDeletedMessageBatch { id, type }

delete/v1/messages/batches/{message_batch_id}?beta=true

List Message Batches

beta.messages.batches.list(**kwargs) -> Page<BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more } >

get/v1/messages/batches?beta=true

Retrieve Message Batch results

beta.messages.batches.results(message_batch_id, **kwargs) -> BetaMessageBatchIndividualResponse { custom_id, result }

get/v1/messages/batches/{message_batch_id}/results?beta=true

Retrieve a Message Batch

beta.messages.batches.retrieve(message_batch_id, **kwargs) -> BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more }

get/v1/messages/batches/{message_batch_id}?beta=true

ModelsExpand Collapse

class BetaDeletedMessageBatch { 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".

Accepts one of the following:

:message_batch_deleted

class BetaMessageBatch { 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: Time

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

formatdate-time

cancel_initiated_at: Time

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

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

formatdate-time

ended_at: Time

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

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 | :canceling | :ended

Processing status of the Message Batch.

Accepts one of the following:

:in_progress

:canceling

:ended

request_counts: BetaMessageBatchRequestCounts { canceled, errored, expired, 2 more }

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

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

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

errored: Integer

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

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

expired: Integer

Number of requests in the Message Batch that have expired.

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

processing: Integer

Number of requests in the Message Batch that are processing.

succeeded: Integer

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".

Accepts one of the following:

:message_batch

class BetaMessageBatchCanceledResult { type }

type: :canceled

Accepts one of the following:

:canceled

class BetaMessageBatchErroredResult { error, type }

error: BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError { message, type }

message: String

type: :invalid_request_error

Accepts one of the following:

:invalid_request_error

class BetaAuthenticationError { message, type }

message: String

type: :authentication_error

Accepts one of the following:

:authentication_error

class BetaBillingError { message, type }

message: String

type: :billing_error

Accepts one of the following:

:billing_error

class BetaPermissionError { message, type }

message: String

type: :permission_error

Accepts one of the following:

:permission_error

class BetaNotFoundError { message, type }

message: String

type: :not_found_error

Accepts one of the following:

:not_found_error

class BetaRateLimitError { message, type }

message: String

type: :rate_limit_error

Accepts one of the following:

:rate_limit_error

class BetaGatewayTimeoutError { message, type }

message: String

type: :timeout_error

Accepts one of the following:

:timeout_error

class BetaAPIError { message, type }

message: String

type: :api_error

Accepts one of the following:

:api_error

class BetaOverloadedError { message, type }

message: String

type: :overloaded_error

Accepts one of the following:

:overloaded_error

request_id: String

type: :error

Accepts one of the following:

:error

type: :errored

Accepts one of the following:

:errored

class BetaMessageBatchExpiredResult { type }

type: :expired

Accepts one of the following:

:expired

class BetaMessageBatchIndividualResponse { 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.

result: BetaMessageBatchResult

Processing result for this request.

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

Accepts one of the following:

class BetaMessageBatchSucceededResult { message, type }

message: BetaMessage { id, container, content, 7 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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: Array[BetaContentBlock]

Content generated by the model.

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

Example:

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

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

For example, if the input messages were:

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

Then the response content might be:

[{"type": "text", "text": "B)"}]

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

context_management: BetaContextManagementResponse { applied_edits }

Context management response.

Information about context management strategies applied during the request.

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 more

The model that will complete your prompt.

See models for additional details and options.

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

String

role: :assistant

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

:assistant

stop_reason: BetaStopReason

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

stop_sequence: 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".

Accepts one of the following:

:message

usage: BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 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.

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: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

type: :succeeded

Accepts one of the following:

:succeeded

class BetaMessageBatchErroredResult { error, type }

error: BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError { message, type }

message: String

type: :invalid_request_error

Accepts one of the following:

:invalid_request_error

class BetaAuthenticationError { message, type }

message: String

type: :authentication_error

Accepts one of the following:

:authentication_error

class BetaBillingError { message, type }

message: String

type: :billing_error

Accepts one of the following:

:billing_error

class BetaPermissionError { message, type }

message: String

type: :permission_error

Accepts one of the following:

:permission_error

class BetaNotFoundError { message, type }

message: String

type: :not_found_error

Accepts one of the following:

:not_found_error

class BetaRateLimitError { message, type }

message: String

type: :rate_limit_error

Accepts one of the following:

:rate_limit_error

class BetaGatewayTimeoutError { message, type }

message: String

type: :timeout_error

Accepts one of the following:

:timeout_error

class BetaAPIError { message, type }

message: String

type: :api_error

Accepts one of the following:

:api_error

class BetaOverloadedError { message, type }

message: String

type: :overloaded_error

Accepts one of the following:

:overloaded_error

request_id: String

type: :error

Accepts one of the following:

:error

type: :errored

Accepts one of the following:

:errored

class BetaMessageBatchCanceledResult { type }

type: :canceled

Accepts one of the following:

:canceled

class BetaMessageBatchExpiredResult { type }

type: :expired

Accepts one of the following:

:expired

class BetaMessageBatchRequestCounts { canceled, errored, expired, 2 more }

canceled: Integer

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

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

errored: Integer

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

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

expired: Integer

Number of requests in the Message Batch that have expired.

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

processing: Integer

Number of requests in the Message Batch that are processing.

succeeded: Integer

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 } | BetaMessageBatchErroredResult { error, type } | BetaMessageBatchCanceledResult { type } | 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:

class BetaMessageBatchSucceededResult { message, type }

message: BetaMessage { id, container, content, 7 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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: Array[BetaContentBlock]

Content generated by the model.

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

Example:

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

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

For example, if the input messages were:

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

Then the response content might be:

[{"type": "text", "text": "B)"}]

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

context_management: BetaContextManagementResponse { applied_edits }

Context management response.

Information about context management strategies applied during the request.

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 more

The model that will complete your prompt.

See models for additional details and options.

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

String

role: :assistant

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

:assistant

stop_reason: BetaStopReason

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

stop_sequence: 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".

Accepts one of the following:

:message

usage: BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 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.

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: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

type: :succeeded

Accepts one of the following:

:succeeded

class BetaMessageBatchErroredResult { error, type }

error: BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError { message, type }

message: String

type: :invalid_request_error

Accepts one of the following:

:invalid_request_error

class BetaAuthenticationError { message, type }

message: String

type: :authentication_error

Accepts one of the following:

:authentication_error

class BetaBillingError { message, type }

message: String

type: :billing_error

Accepts one of the following:

:billing_error

class BetaPermissionError { message, type }

message: String

type: :permission_error

Accepts one of the following:

:permission_error

class BetaNotFoundError { message, type }

message: String

type: :not_found_error

Accepts one of the following:

:not_found_error

class BetaRateLimitError { message, type }

message: String

type: :rate_limit_error

Accepts one of the following:

:rate_limit_error

class BetaGatewayTimeoutError { message, type }

message: String

type: :timeout_error

Accepts one of the following:

:timeout_error

class BetaAPIError { message, type }

message: String

type: :api_error

Accepts one of the following:

:api_error

class BetaOverloadedError { message, type }

message: String

type: :overloaded_error

Accepts one of the following:

:overloaded_error

request_id: String

type: :error

Accepts one of the following:

:error

type: :errored

Accepts one of the following:

:errored

class BetaMessageBatchCanceledResult { type }

type: :canceled

Accepts one of the following:

:canceled

class BetaMessageBatchExpiredResult { type }

type: :expired

Accepts one of the following:

:expired

class BetaMessageBatchSucceededResult { message, type }

message: BetaMessage { id, container, content, 7 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: BetaContainer { 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: Time

The time at which the container will expire.

formatdate-time

skills: Array[BetaSkill { skill_id, type, version } ]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64

minLength1

type: :anthropic | :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: Array[BetaContentBlock]

Content generated by the model.

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

Example:

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

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

For example, if the input messages were:

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

Then the response content might be:

[{"type": "text", "text": "B)"}]

Accepts one of the following:

class BetaTextBlock { citations, text, type }

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

class BetaThinkingBlock { signature, thinking, type }

signature: String

thinking: String

type: :thinking

Accepts one of the following:

:thinking

class BetaRedactedThinkingBlock { data, type }

data: String

type: :redacted_thinking

Accepts one of the following:

:redacted_thinking

class BetaToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

minLength1

type: :tool_use

Accepts one of the following:

:tool_use

class BetaServerToolUseBlock { id, input, name, type }

id: String

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

type: :server_tool_use

Accepts one of the following:

:server_tool_use

class BetaWebSearchToolResultBlock { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError { error_code, type }

error_code: BetaWebSearchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:max_uses_exceeded

:too_many_requests

:query_too_long

type: :web_search_tool_result_error

Accepts one of the following:

:web_search_tool_result_error

Array[BetaWebSearchResultBlock { encrypted_content, page_age, title, 2 more } ]

encrypted_content: String

page_age: String

title: String

type: :web_search_result

Accepts one of the following:

:web_search_result

url: String

tool_use_id: String

type: :web_search_tool_result

Accepts one of the following:

:web_search_tool_result

class BetaWebFetchToolResultBlock { content, tool_use_id, type }

content: BetaWebFetchToolResultErrorBlock { error_code, type } | BetaWebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock { error_code, type }

error_code: BetaWebFetchToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:url_too_long

:url_not_allowed

:url_not_accessible

:unsupported_content_type

:too_many_requests

:max_uses_exceeded

:unavailable

type: :web_fetch_tool_result_error

Accepts one of the following:

:web_fetch_tool_result_error

class BetaWebFetchBlock { content, retrieved_at, type, url }

content: BetaDocumentBlock { citations, source, title, type }

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: bool

source: BetaBase64PDFSource { data, media_type, type } | BetaPlainTextSource { data, media_type, type }

Accepts one of the following:

class BetaBase64PDFSource { data, media_type, type }

data: String

formatbyte

media_type: :"application/pdf"

Accepts one of the following:

:"application/pdf"

type: :base64

Accepts one of the following:

:base64

class BetaPlainTextSource { data, media_type, type }

data: String

media_type: :"text/plain"

Accepts one of the following:

:"text/plain"

type: :text

Accepts one of the following:

:text

title: String

The title of the document

type: :document

Accepts one of the following:

:document

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

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

Accepts one of the following:

:web_fetch_tool_result

class BetaCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError { error_code, type }

error_code: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

type: :code_execution_tool_result_error

Accepts one of the following:

:code_execution_tool_result_error

class BetaCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :code_execution_output

Accepts one of the following:

:code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :code_execution_result

Accepts one of the following:

:code_execution_result

tool_use_id: String

type: :code_execution_tool_result

Accepts one of the following:

:code_execution_tool_result

class BetaBashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BetaBashCodeExecutionToolResultError { error_code, type } | BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

class BetaBashCodeExecutionToolResultError { error_code, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:output_file_too_large

type: :bash_code_execution_tool_result_error

Accepts one of the following:

:bash_code_execution_tool_result_error

class BetaBashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array[BetaBashCodeExecutionOutputBlock { file_id, type } ]

file_id: String

type: :bash_code_execution_output

Accepts one of the following:

:bash_code_execution_output

return_code: Integer

stderr: String

stdout: String

type: :bash_code_execution_result

Accepts one of the following:

:bash_code_execution_result

tool_use_id: String

type: :bash_code_execution_tool_result

Accepts one of the following:

:bash_code_execution_tool_result

class BetaTextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | 2 more

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

:file_not_found

error_message: String

type: :text_editor_code_execution_tool_result_error

Accepts one of the following:

:text_editor_code_execution_tool_result_error

class BetaTextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: String

file_type: :text | :image | :pdf

Accepts one of the following:

:text

:image

:pdf

num_lines: Integer

start_line: Integer

total_lines: Integer

type: :text_editor_code_execution_view_result

Accepts one of the following:

:text_editor_code_execution_view_result

class BetaTextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: bool

type: :text_editor_code_execution_create_result

Accepts one of the following:

:text_editor_code_execution_create_result

class BetaTextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array[String]

new_lines: Integer

new_start: Integer

old_lines: Integer

old_start: Integer

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

Accepts one of the following:

:text_editor_code_execution_tool_result

class BetaMCPToolUseBlock { id, input, name, 2 more }

id: String

input: Hash[Symbol, untyped]

The name of the MCP tool

server_name: String

The name of the MCP server

type: :mcp_tool_use

Accepts one of the following:

:mcp_tool_use

class BetaMCPToolResultBlock { content, is_error, tool_use_id, type }

content: String | Array[BetaTextBlock { citations, text, type } ]

Accepts one of the following:

String

Array[BetaTextBlock { citations, text, type } ]

citations: Array[BetaTextCitation]

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

minimum0

type: :char_location

Accepts one of the following:

:char_location

class BetaCitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

minimum1

type: :page_location

Accepts one of the following:

:page_location

class BetaCitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: String

document_index: Integer

minimum0

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

minimum0

type: :content_block_location

Accepts one of the following:

:content_block_location

class BetaCitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: String

encrypted_index: String

title: String

maxLength512

type: :web_search_result_location

Accepts one of the following:

:web_search_result_location

url: String

class BetaCitationSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }

cited_text: String

end_block_index: Integer

search_result_index: Integer

minimum0

source: String

start_block_index: Integer

minimum0

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

maxLength5000000

minLength0

type: :text

Accepts one of the following:

:text

is_error: bool

tool_use_id: String

type: :mcp_tool_result

Accepts one of the following:

:mcp_tool_result

class BetaContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String

type: :container_upload

Accepts one of the following:

:container_upload

context_management: BetaContextManagementResponse { applied_edits }

Context management response.

Information about context management strategies applied during the request.

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: Integer

Number of tool uses that were cleared.

minimum0

type: :clear_tool_uses_20250919

The type of context management edit applied.

Accepts one of the following:

:clear_tool_uses_20250919

class BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: Integer

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: Integer

Number of thinking turns that were cleared.

minimum0

type: :clear_thinking_20251015

The type of context management edit applied.

Accepts one of the following:

:clear_thinking_20251015

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-3-7-sonnet-latest" | :"claude-3-7-sonnet-20250219" | :"claude-3-5-haiku-latest" | 15 more

The model that will complete your prompt.

See models for additional details and options.

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

String

role: :assistant

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

:assistant

stop_reason: BetaStopReason

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

:end_turn

:max_tokens

:stop_sequence

:tool_use

:pause_turn

:refusal

:model_context_window_exceeded

stop_sequence: 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".

Accepts one of the following:

:message

usage: BetaUsage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 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.

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: BetaCacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: Integer

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

minimum0

ephemeral_5m_input_tokens: Integer

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

minimum0

cache_creation_input_tokens: Integer

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

minimum0

cache_read_input_tokens: Integer

The number of input tokens read from the cache.

minimum0

input_tokens: Integer

The number of input tokens which were used.

minimum0

output_tokens: Integer

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0

web_search_requests: Integer

The number of web search tool requests.

minimum0

service_tier: :standard | :priority | :batch

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

Accepts one of the following:

:standard

:priority

:batch

type: :succeeded

Accepts one of the following:

:succeeded

BetaModels

List Models

beta.models.list(**kwargs) -> Page<BetaModelInfo { id, created_at, display_name, type } >

get/v1/models?beta=true

Get a Model

beta.models.retrieve(model_id, **kwargs) -> BetaModelInfo { id, created_at, display_name, type }

get/v1/models/{model_id}?beta=true

ModelsExpand Collapse

class BetaModelInfo { id, created_at, display_name, type }

id: String

Unique model identifier.

created_at: Time

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".

Accepts one of the following:

:model

BetaSkills

Create Skill

beta.skills.create(**kwargs) -> SkillCreateResponse { id, created_at, display_title, 4 more }

post/v1/skills?beta=true

Delete Skill

beta.skills.delete(skill_id, **kwargs) -> SkillDeleteResponse { id, type }

delete/v1/skills/{skill_id}?beta=true

List Skills

beta.skills.list(**kwargs) -> PageCursor<SkillListResponse { id, created_at, display_title, 4 more } >

get/v1/skills?beta=true

Get Skill

beta.skills.retrieve(skill_id, **kwargs) -> SkillRetrieveResponse { id, created_at, display_title, 4 more }

get/v1/skills/{skill_id}?beta=true

Beta

ModelsExpand Collapse

BetaFiles

ModelsExpand Collapse

BetaMessages

ModelsExpand Collapse

BetaMessagesBatches

ModelsExpand Collapse

BetaModels

ModelsExpand Collapse

BetaSkills

BetaSkillsVersions