Batches

Create a Message Batch

beta.messages.batches.create(**kwargs) -> BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more }

post/v1/messages/batches

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}

List Message Batches

beta.messages.batches.list(**kwargs) -> Page<BetaMessageBatch { id, archived_at, cancel_initiated_at, 7 more } >

get/v1/messages/batches

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

Delete a Message Batch

beta.messages.batches.delete(message_batch_id, **kwargs) -> BetaDeletedMessageBatch { id, type }

delete/v1/messages/batches/{message_batch_id}

Retrieve Message Batch results

beta.messages.batches.results(message_batch_id, **kwargs) -> BetaMessageBatchIndividualResponse { custom_id, result }

get/v1/messages/batches/{message_batch_id}/results

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.

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

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

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

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

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

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

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

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

source: String

start_block_index: Integer

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

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, 2 more }

id: String

input: Hash[Symbol, untyped]

type: :tool_use

Accepts one of the following:

:tool_use

caller_: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

class BetaDirectCaller { type }

Tool invocation directly from the model.

type: :direct

Accepts one of the following:

:direct

class BetaServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String

type: :code_execution_20250825

Accepts one of the following:

:code_execution_20250825

class BetaServerToolUseBlock { id, caller_, input, 2 more }

id: String

caller_: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

class BetaDirectCaller { type }

Tool invocation directly from the model.

type: :direct

Accepts one of the following:

:direct

class BetaServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String

type: :code_execution_20250825

Accepts one of the following:

:code_execution_20250825

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

:tool_search_tool_regex

:tool_search_tool_bm25

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

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 BetaToolSearchToolResultBlock { content, tool_use_id, type }

content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }

Accepts one of the following:

class BetaToolSearchToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

error_message: String

type: :tool_search_tool_result_error

Accepts one of the following:

:tool_search_tool_result_error

class BetaToolSearchToolSearchResultBlock { tool_references, type }

tool_references: Array[BetaToolReferenceBlock { tool_name, type } ]

tool_name: String

type: :tool_reference

Accepts one of the following:

:tool_reference

type: :tool_search_tool_search_result

Accepts one of the following:

:tool_search_tool_search_result

tool_use_id: String

type: :tool_search_tool_result

Accepts one of the following:

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

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

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

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

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

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

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

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

source: String

start_block_index: Integer

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

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.

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

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-opus-4-5-20251101"

Premium model combining maximum intelligence with practical performance

:"claude-opus-4-5"

Premium model combining maximum intelligence with practical performance

:"claude-3-7-sonnet-latest"

High-performance model with early extended thinking

:"claude-3-7-sonnet-20250219"

High-performance model with early extended thinking

:"claude-3-5-haiku-latest"

Fastest and most compact model for near-instant responsiveness

:"claude-3-5-haiku-20241022"

Our fastest model

:"claude-haiku-4-5"

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

:"claude-haiku-4-5-20251001"

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

:"claude-sonnet-4-20250514"

High-performance model with extended thinking

:"claude-sonnet-4-0"

High-performance model with extended thinking

:"claude-4-sonnet-20250514"

High-performance model with extended thinking

:"claude-sonnet-4-5"

Our best model for real-world agents and coding

:"claude-sonnet-4-5-20250929"

Our best model for real-world agents and coding

:"claude-opus-4-0"

Our most capable model

:"claude-opus-4-20250514"

Our most capable model

:"claude-4-opus-20250514"

Our most capable model

:"claude-opus-4-1-20250805"

Our most capable model

:"claude-3-opus-latest"

Excels at writing and complex tasks

:"claude-3-opus-20240229"

Excels at writing and complex tasks

:"claude-3-haiku-20240307"

Our previous most fast and cost-effective

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

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

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

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

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

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

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

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

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

source: String

start_block_index: Integer

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

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, 2 more }

id: String

input: Hash[Symbol, untyped]

type: :tool_use

Accepts one of the following:

:tool_use

caller_: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

class BetaDirectCaller { type }

Tool invocation directly from the model.

type: :direct

Accepts one of the following:

:direct

class BetaServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String

type: :code_execution_20250825

Accepts one of the following:

:code_execution_20250825

class BetaServerToolUseBlock { id, caller_, input, 2 more }

id: String

caller_: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

class BetaDirectCaller { type }

Tool invocation directly from the model.

type: :direct

Accepts one of the following:

:direct

class BetaServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String

type: :code_execution_20250825

Accepts one of the following:

:code_execution_20250825

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

:tool_search_tool_regex

:tool_search_tool_bm25

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

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 BetaToolSearchToolResultBlock { content, tool_use_id, type }

content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }

Accepts one of the following:

class BetaToolSearchToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

error_message: String

type: :tool_search_tool_result_error

Accepts one of the following:

:tool_search_tool_result_error

class BetaToolSearchToolSearchResultBlock { tool_references, type }

tool_references: Array[BetaToolReferenceBlock { tool_name, type } ]

tool_name: String

type: :tool_reference

Accepts one of the following:

:tool_reference

type: :tool_search_tool_search_result

Accepts one of the following:

:tool_search_tool_search_result

tool_use_id: String

type: :tool_search_tool_result

Accepts one of the following:

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

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

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

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

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

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

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

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

source: String

start_block_index: Integer

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

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-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-opus-4-5-20251101"

Premium model combining maximum intelligence with practical performance

:"claude-opus-4-5"

Premium model combining maximum intelligence with practical performance

:"claude-3-7-sonnet-latest"

High-performance model with early extended thinking

:"claude-3-7-sonnet-20250219"

High-performance model with early extended thinking

:"claude-3-5-haiku-latest"

Fastest and most compact model for near-instant responsiveness

:"claude-3-5-haiku-20241022"

Our fastest model

:"claude-haiku-4-5"

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

:"claude-haiku-4-5-20251001"

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

:"claude-sonnet-4-20250514"

High-performance model with extended thinking

:"claude-sonnet-4-0"

High-performance model with extended thinking

:"claude-4-sonnet-20250514"

High-performance model with extended thinking

:"claude-sonnet-4-5"

Our best model for real-world agents and coding

:"claude-sonnet-4-5-20250929"

Our best model for real-world agents and coding

:"claude-opus-4-0"

Our most capable model

:"claude-opus-4-20250514"

Our most capable model

:"claude-4-opus-20250514"

Our most capable model

:"claude-opus-4-1-20250805"

Our most capable model

:"claude-3-opus-latest"

Excels at writing and complex tasks

:"claude-3-opus-20240229"

Excels at writing and complex tasks

:"claude-3-haiku-20240307"

Our previous most fast and cost-effective

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

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

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

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

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

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

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

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

source: String

start_block_index: Integer

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

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, 2 more }

id: String

input: Hash[Symbol, untyped]

type: :tool_use

Accepts one of the following:

:tool_use

caller_: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

class BetaDirectCaller { type }

Tool invocation directly from the model.

type: :direct

Accepts one of the following:

:direct

class BetaServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String

type: :code_execution_20250825

Accepts one of the following:

:code_execution_20250825

class BetaServerToolUseBlock { id, caller_, input, 2 more }

id: String

caller_: BetaDirectCaller { type } | BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

class BetaDirectCaller { type }

Tool invocation directly from the model.

type: :direct

Accepts one of the following:

:direct

class BetaServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String

type: :code_execution_20250825

Accepts one of the following:

:code_execution_20250825

input: Hash[Symbol, untyped]

Accepts one of the following:

:web_search

:web_fetch

:code_execution

:bash_code_execution

:text_editor_code_execution

:tool_search_tool_regex

:tool_search_tool_bm25

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

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 BetaToolSearchToolResultBlock { content, tool_use_id, type }

content: BetaToolSearchToolResultError { error_code, error_message, type } | BetaToolSearchToolSearchResultBlock { tool_references, type }

Accepts one of the following:

class BetaToolSearchToolResultError { error_code, error_message, type }

error_code: :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded

Accepts one of the following:

:invalid_tool_input

:unavailable

:too_many_requests

:execution_time_exceeded

error_message: String

type: :tool_search_tool_result_error

Accepts one of the following:

:tool_search_tool_result_error

class BetaToolSearchToolSearchResultBlock { tool_references, type }

tool_references: Array[BetaToolReferenceBlock { tool_name, type } ]

tool_name: String

type: :tool_reference

Accepts one of the following:

:tool_reference

type: :tool_search_tool_search_result

Accepts one of the following:

:tool_search_tool_search_result

tool_use_id: String

type: :tool_search_tool_result

Accepts one of the following:

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

document_title: String

end_char_index: Integer

file_id: String

start_char_index: Integer

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

document_title: String

end_page_number: Integer

file_id: String

start_page_number: Integer

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

document_title: String

end_block_index: Integer

file_id: String

start_block_index: Integer

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

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

source: String

start_block_index: Integer

title: String

type: :search_result_location

Accepts one of the following:

:search_result_location

text: String

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-opus-4-5-20251101" | :"claude-opus-4-5" | :"claude-3-7-sonnet-latest" | 17 more

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

:"claude-opus-4-5-20251101"

Premium model combining maximum intelligence with practical performance

:"claude-opus-4-5"

Premium model combining maximum intelligence with practical performance

:"claude-3-7-sonnet-latest"

High-performance model with early extended thinking

:"claude-3-7-sonnet-20250219"

High-performance model with early extended thinking

:"claude-3-5-haiku-latest"

Fastest and most compact model for near-instant responsiveness

:"claude-3-5-haiku-20241022"

Our fastest model

:"claude-haiku-4-5"

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

:"claude-haiku-4-5-20251001"

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

:"claude-sonnet-4-20250514"

High-performance model with extended thinking

:"claude-sonnet-4-0"

High-performance model with extended thinking

:"claude-4-sonnet-20250514"

High-performance model with extended thinking

:"claude-sonnet-4-5"

Our best model for real-world agents and coding

:"claude-sonnet-4-5-20250929"

Our best model for real-world agents and coding

:"claude-opus-4-0"

Our most capable model

:"claude-opus-4-20250514"

Our most capable model

:"claude-4-opus-20250514"

Our most capable model

:"claude-opus-4-1-20250805"

Our most capable model

:"claude-3-opus-latest"

Excels at writing and complex tasks

:"claude-3-opus-20240229"

Excels at writing and complex tasks

:"claude-3-haiku-20240307"

Our previous most fast and cost-effective

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