Batches

Retrieve a Message Batch

get/v1/messages/batches/{message_batch_id}

Cancel a Message Batch

post/v1/messages/batches/{message_batch_id}/cancel

Delete a Message Batch

delete/v1/messages/batches/{message_batch_id}

Retrieve Message Batch results

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

ModelsExpand Collapse

BetaDeletedMessageBatch = object { id, type }

id: string

ID of the Message Batch.

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

Accepts one of the following:

"message_batch_deleted"

BetaMessageBatch = object { id, archived_at, cancel_initiated_at, 7 more }

id: string

Unique object identifier.

The format and length of IDs may change over time.

archived_at: string

RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

formatdate-time

cancel_initiated_at: string

RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.

formatdate-time

created_at: string

RFC 3339 datetime string representing the time at which the Message Batch was created.

formatdate-time

ended_at: string

RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.

Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.

formatdate-time

expires_at: string

RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.

formatdate-time

processing_status: "in_progress" or "canceling" or "ended"

Processing status of the Message Batch.

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

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

errored: number

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

expired: number

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

processing: number

Number of requests in the Message Batch that are processing.

succeeded: number

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

results_url: string

URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.

Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

type: "message_batch"

Object type.

For Message Batches, this is always "message_batch".

Accepts one of the following:

"message_batch"

BetaMessageBatchCanceledResult = object { type }

type: "canceled"

Accepts one of the following:

"canceled"

BetaMessageBatchErroredResult = object { error, type }

error: BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

BetaInvalidRequestError = object { message, type }

message: string

type: "invalid_request_error"

Accepts one of the following:

"invalid_request_error"

BetaAuthenticationError = object { message, type }

message: string

type: "authentication_error"

Accepts one of the following:

"authentication_error"

BetaBillingError = object { message, type }

message: string

type: "billing_error"

Accepts one of the following:

"billing_error"

BetaPermissionError = object { message, type }

message: string

type: "permission_error"

Accepts one of the following:

"permission_error"

BetaNotFoundError = object { message, type }

message: string

type: "not_found_error"

Accepts one of the following:

"not_found_error"

BetaRateLimitError = object { message, type }

message: string

type: "rate_limit_error"

Accepts one of the following:

"rate_limit_error"

BetaGatewayTimeoutError = object { message, type }

message: string

type: "timeout_error"

Accepts one of the following:

"timeout_error"

BetaAPIError = object { message, type }

message: string

type: "api_error"

Accepts one of the following:

"api_error"

BetaOverloadedError = object { 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"

BetaMessageBatchExpiredResult = object { type }

type: "expired"

Accepts one of the following:

"expired"

BetaMessageBatchIndividualResponse = object { custom_id, result }

This is a single line in the response .jsonl file and does not represent the response as a whole.

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:

BetaMessageBatchSucceededResult = object { 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: string

The time at which the container will expire.

formatdate-time

skills: array of BetaSkill { skill_id, type, version }

Skills loaded in the container

skill_id: string

Skill ID

maxLength64

minLength1

type: "anthropic" or "custom"

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

"anthropic"

"custom"

version: string

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: array of 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:

BetaTextBlock = object { citations, text, type }

citations: array of 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:

BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_char_index: number

file_id: string

start_char_index: number

type: "char_location"

Accepts one of the following:

"char_location"

BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_page_number: number

file_id: string

start_page_number: number

type: "page_location"

Accepts one of the following:

"page_location"

BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_block_index: number

file_id: string

start_block_index: number

type: "content_block_location"

Accepts one of the following:

"content_block_location"

BetaCitationsWebSearchResultLocation = object { 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

BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }

cited_text: string

end_block_index: number

search_result_index: number

source: string

start_block_index: number

title: string

type: "search_result_location"

Accepts one of the following:

"search_result_location"

text: string

type: "text"

Accepts one of the following:

"text"

BetaThinkingBlock = object { signature, thinking, type }

signature: string

thinking: string

type: "thinking"

Accepts one of the following:

"thinking"

BetaRedactedThinkingBlock = object { data, type }

data: string

type: "redacted_thinking"

Accepts one of the following:

"redacted_thinking"

BetaToolUseBlock = object { id, input, name, 2 more }

id: string

input: map[unknown]

type: "tool_use"

Accepts one of the following:

"tool_use"

caller: optional BetaDirectCaller { type } or BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

BetaDirectCaller = object { type }

Tool invocation directly from the model.

type: "direct"

Accepts one of the following:

"direct"

BetaServerToolCaller = object { 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"

BetaServerToolUseBlock = object { id, caller, input, 2 more }

id: string

caller: BetaDirectCaller { type } or BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

BetaDirectCaller = object { type }

Tool invocation directly from the model.

type: "direct"

Accepts one of the following:

"direct"

BetaServerToolCaller = object { 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: map[unknown]

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"

BetaWebSearchToolResultBlock = object { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

BetaWebSearchToolResultError = object { 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"

UnionMember1 = array of 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"

BetaWebFetchToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaWebFetchToolResultErrorBlock = object { 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"

BetaWebFetchBlock = object { content, retrieved_at, type, url }

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

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: boolean

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

Accepts one of the following:

BetaBase64PDFSource = object { 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"

BetaPlainTextSource = object { 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"

BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

BetaCodeExecutionToolResultError = object { 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"

BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }

content: array of BetaCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "code_execution_output"

Accepts one of the following:

"code_execution_output"

return_code: number

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"

BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaBashCodeExecutionToolResultError = object { error_code, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

Accepts one of the following:

"bash_code_execution_tool_result_error"

BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }

content: array of BetaBashCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "bash_code_execution_output"

Accepts one of the following:

"bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

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"

BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"file_not_found"

error_message: string

type: "text_editor_code_execution_tool_result_error"

Accepts one of the following:

"text_editor_code_execution_tool_result_error"

BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }

content: string

file_type: "text" or "image" or "pdf"

Accepts one of the following:

"text"

"image"

"pdf"

num_lines: number

start_line: number

total_lines: number

type: "text_editor_code_execution_view_result"

Accepts one of the following:

"text_editor_code_execution_view_result"

BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }

is_file_update: boolean

type: "text_editor_code_execution_create_result"

Accepts one of the following:

"text_editor_code_execution_create_result"

BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }

lines: array of string

new_lines: number

new_start: number

old_lines: number

old_start: number

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"

BetaToolSearchToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaToolSearchToolResultError = object { error_code, error_message, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

error_message: string

type: "tool_search_tool_result_error"

Accepts one of the following:

"tool_search_tool_result_error"

BetaToolSearchToolSearchResultBlock = object { tool_references, type }

tool_references: array of 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"

BetaMCPToolUseBlock = object { id, input, name, 2 more }

id: string

input: map[unknown]

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"

BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }

content: string or array of BetaTextBlock { citations, text, type }

Accepts one of the following:

UnionMember0 = string

BetaMCPToolResultBlockContent = array of BetaTextBlock { citations, text, type }

citations: array of BetaTextCitation

Citations supporting the text block.

Accepts one of the following:

BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_char_index: number

file_id: string

start_char_index: number

type: "char_location"

Accepts one of the following:

"char_location"

BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_page_number: number

file_id: string

start_page_number: number

type: "page_location"

Accepts one of the following:

"page_location"

BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_block_index: number

file_id: string

start_block_index: number

type: "content_block_location"

Accepts one of the following:

"content_block_location"

BetaCitationsWebSearchResultLocation = object { 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

BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }

cited_text: string

end_block_index: number

search_result_index: number

source: string

start_block_index: number

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

tool_use_id: string

type: "mcp_tool_result"

Accepts one of the following:

"mcp_tool_result"

BetaContainerUploadBlock = object { file_id, type }

Response model for a file uploaded to the container.

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 of BetaClearToolUses20250919EditResponse { cleared_input_tokens, cleared_tool_uses, type } or BetaClearThinking20251015EditResponse { cleared_input_tokens, cleared_thinking_turns, type }

List of context management edits that were applied.

Accepts one of the following:

BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: number

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: number

Number of tool uses that were cleared.

minimum0

type: "clear_tool_uses_20250919"

The type of context management edit applied.

Accepts one of the following:

"clear_tool_uses_20250919"

BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: number

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: number

Number of thinking turns that were cleared.

minimum0

type: "clear_thinking_20251015"

The type of context management edit applied.

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:

UnionMember0 = "claude-opus-4-5-20251101" or "claude-opus-4-5" or "claude-3-7-sonnet-latest" or 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

UnionMember1 = 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: number

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

minimum0

ephemeral_5m_input_tokens: number

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

minimum0

cache_creation_input_tokens: number

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

minimum0

cache_read_input_tokens: number

The number of input tokens read from the cache.

minimum0

input_tokens: number

The number of input tokens which were used.

minimum0

output_tokens: number

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: number

The number of web fetch tool requests.

minimum0

web_search_requests: number

The number of web search tool requests.

minimum0

service_tier: "standard" or "priority" or "batch"

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

Accepts one of the following:

"standard"

"priority"

"batch"

type: "succeeded"

Accepts one of the following:

"succeeded"

BetaMessageBatchErroredResult = object { error, type }

error: BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

BetaInvalidRequestError = object { message, type }

message: string

type: "invalid_request_error"

Accepts one of the following:

"invalid_request_error"

BetaAuthenticationError = object { message, type }

message: string

type: "authentication_error"

Accepts one of the following:

"authentication_error"

BetaBillingError = object { message, type }

message: string

type: "billing_error"

Accepts one of the following:

"billing_error"

BetaPermissionError = object { message, type }

message: string

type: "permission_error"

Accepts one of the following:

"permission_error"

BetaNotFoundError = object { message, type }

message: string

type: "not_found_error"

Accepts one of the following:

"not_found_error"

BetaRateLimitError = object { message, type }

message: string

type: "rate_limit_error"

Accepts one of the following:

"rate_limit_error"

BetaGatewayTimeoutError = object { message, type }

message: string

type: "timeout_error"

Accepts one of the following:

"timeout_error"

BetaAPIError = object { message, type }

message: string

type: "api_error"

Accepts one of the following:

"api_error"

BetaOverloadedError = object { 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"

BetaMessageBatchCanceledResult = object { type }

type: "canceled"

Accepts one of the following:

"canceled"

BetaMessageBatchExpiredResult = object { type }

type: "expired"

Accepts one of the following:

"expired"

BetaMessageBatchRequestCounts = object { canceled, errored, expired, 2 more }

canceled: number

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

errored: number

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

expired: number

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

processing: number

Number of requests in the Message Batch that are processing.

succeeded: number

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

BetaMessageBatchResult = BetaMessageBatchSucceededResult { message, type } or BetaMessageBatchErroredResult { error, type } or BetaMessageBatchCanceledResult { type } or BetaMessageBatchExpiredResult { type }

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

Accepts one of the following:

BetaMessageBatchSucceededResult = object { 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: string

The time at which the container will expire.

formatdate-time

skills: array of BetaSkill { skill_id, type, version }

Skills loaded in the container

skill_id: string

Skill ID

maxLength64

minLength1

type: "anthropic" or "custom"

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

"anthropic"

"custom"

version: string

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: array of 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:

BetaTextBlock = object { citations, text, type }

citations: array of BetaTextCitation

Citations supporting the text block.

Accepts one of the following:

BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_char_index: number

file_id: string

start_char_index: number

type: "char_location"

Accepts one of the following:

"char_location"

BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_page_number: number

file_id: string

start_page_number: number

type: "page_location"

Accepts one of the following:

"page_location"

BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_block_index: number

file_id: string

start_block_index: number

type: "content_block_location"

Accepts one of the following:

"content_block_location"

BetaCitationsWebSearchResultLocation = object { 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

BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }

cited_text: string

end_block_index: number

search_result_index: number

source: string

start_block_index: number

title: string

type: "search_result_location"

Accepts one of the following:

"search_result_location"

text: string

type: "text"

Accepts one of the following:

"text"

BetaThinkingBlock = object { signature, thinking, type }

signature: string

thinking: string

type: "thinking"

Accepts one of the following:

"thinking"

BetaRedactedThinkingBlock = object { data, type }

data: string

type: "redacted_thinking"

Accepts one of the following:

"redacted_thinking"

BetaToolUseBlock = object { id, input, name, 2 more }

id: string

input: map[unknown]

type: "tool_use"

Accepts one of the following:

"tool_use"

caller: optional BetaDirectCaller { type } or BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

BetaDirectCaller = object { type }

Tool invocation directly from the model.

type: "direct"

Accepts one of the following:

"direct"

BetaServerToolCaller = object { 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"

BetaServerToolUseBlock = object { id, caller, input, 2 more }

id: string

caller: BetaDirectCaller { type } or BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

BetaDirectCaller = object { type }

Tool invocation directly from the model.

type: "direct"

Accepts one of the following:

"direct"

BetaServerToolCaller = object { 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: map[unknown]

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"

BetaWebSearchToolResultBlock = object { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

BetaWebSearchToolResultError = object { 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"

UnionMember1 = array of 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"

BetaWebFetchToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaWebFetchToolResultErrorBlock = object { 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"

BetaWebFetchBlock = object { content, retrieved_at, type, url }

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

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: boolean

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

Accepts one of the following:

BetaBase64PDFSource = object { 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"

BetaPlainTextSource = object { 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"

BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

BetaCodeExecutionToolResultError = object { 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"

BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }

content: array of BetaCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "code_execution_output"

Accepts one of the following:

"code_execution_output"

return_code: number

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"

BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaBashCodeExecutionToolResultError = object { error_code, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

Accepts one of the following:

"bash_code_execution_tool_result_error"

BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }

content: array of BetaBashCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "bash_code_execution_output"

Accepts one of the following:

"bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

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"

BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }

Accepts one of the following:

BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"file_not_found"

error_message: string

type: "text_editor_code_execution_tool_result_error"

Accepts one of the following:

"text_editor_code_execution_tool_result_error"

BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }

content: string

file_type: "text" or "image" or "pdf"

Accepts one of the following:

"text"

"image"

"pdf"

num_lines: number

start_line: number

total_lines: number

type: "text_editor_code_execution_view_result"

Accepts one of the following:

"text_editor_code_execution_view_result"

BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }

is_file_update: boolean

type: "text_editor_code_execution_create_result"

Accepts one of the following:

"text_editor_code_execution_create_result"

BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }

lines: array of string

new_lines: number

new_start: number

old_lines: number

old_start: number

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"

BetaToolSearchToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaToolSearchToolResultError = object { error_code, error_message, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

error_message: string

type: "tool_search_tool_result_error"

Accepts one of the following:

"tool_search_tool_result_error"

BetaToolSearchToolSearchResultBlock = object { tool_references, type }

tool_references: array of 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"

BetaMCPToolUseBlock = object { id, input, name, 2 more }

id: string

input: map[unknown]

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"

BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }

content: string or array of BetaTextBlock { citations, text, type }

Accepts one of the following:

UnionMember0 = string

BetaMCPToolResultBlockContent = array of BetaTextBlock { citations, text, type }

citations: array of BetaTextCitation

Citations supporting the text block.

Accepts one of the following:

BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_char_index: number

file_id: string

start_char_index: number

type: "char_location"

Accepts one of the following:

"char_location"

BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_page_number: number

file_id: string

start_page_number: number

type: "page_location"

Accepts one of the following:

"page_location"

BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_block_index: number

file_id: string

start_block_index: number

type: "content_block_location"

Accepts one of the following:

"content_block_location"

BetaCitationsWebSearchResultLocation = object { 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

BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }

cited_text: string

end_block_index: number

search_result_index: number

source: string

start_block_index: number

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

tool_use_id: string

type: "mcp_tool_result"

Accepts one of the following:

"mcp_tool_result"

BetaContainerUploadBlock = object { file_id, type }

Response model for a file uploaded to the container.

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:

BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: number

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: number

Number of tool uses that were cleared.

minimum0

type: "clear_tool_uses_20250919"

The type of context management edit applied.

Accepts one of the following:

"clear_tool_uses_20250919"

BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: number

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: number

Number of thinking turns that were cleared.

minimum0

type: "clear_thinking_20251015"

The type of context management edit applied.

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:

UnionMember0 = "claude-opus-4-5-20251101" or "claude-opus-4-5" or "claude-3-7-sonnet-latest" or 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

UnionMember1 = 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: number

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

minimum0

ephemeral_5m_input_tokens: number

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

minimum0

cache_creation_input_tokens: number

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

minimum0

cache_read_input_tokens: number

The number of input tokens read from the cache.

minimum0

input_tokens: number

The number of input tokens which were used.

minimum0

output_tokens: number

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: number

The number of web fetch tool requests.

minimum0

web_search_requests: number

The number of web search tool requests.

minimum0

service_tier: "standard" or "priority" or "batch"

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

Accepts one of the following:

"standard"

"priority"

"batch"

type: "succeeded"

Accepts one of the following:

"succeeded"

BetaMessageBatchErroredResult = object { error, type }

error: BetaErrorResponse { error, request_id, type }

error: BetaError

Accepts one of the following:

BetaInvalidRequestError = object { message, type }

message: string

type: "invalid_request_error"

Accepts one of the following:

"invalid_request_error"

BetaAuthenticationError = object { message, type }

message: string

type: "authentication_error"

Accepts one of the following:

"authentication_error"

BetaBillingError = object { message, type }

message: string

type: "billing_error"

Accepts one of the following:

"billing_error"

BetaPermissionError = object { message, type }

message: string

type: "permission_error"

Accepts one of the following:

"permission_error"

BetaNotFoundError = object { message, type }

message: string

type: "not_found_error"

Accepts one of the following:

"not_found_error"

BetaRateLimitError = object { message, type }

message: string

type: "rate_limit_error"

Accepts one of the following:

"rate_limit_error"

BetaGatewayTimeoutError = object { message, type }

message: string

type: "timeout_error"

Accepts one of the following:

"timeout_error"

BetaAPIError = object { message, type }

message: string

type: "api_error"

Accepts one of the following:

"api_error"

BetaOverloadedError = object { 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"

BetaMessageBatchCanceledResult = object { type }

type: "canceled"

Accepts one of the following:

"canceled"

BetaMessageBatchExpiredResult = object { type }

type: "expired"

Accepts one of the following:

"expired"

BetaMessageBatchSucceededResult = object { 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: string

The time at which the container will expire.

formatdate-time

skills: array of BetaSkill { skill_id, type, version }

Skills loaded in the container

skill_id: string

Skill ID

maxLength64

minLength1

type: "anthropic" or "custom"

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

Accepts one of the following:

"anthropic"

"custom"

version: string

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: array of 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:

BetaTextBlock = object { citations, text, type }

citations: array of BetaTextCitation

Citations supporting the text block.

Accepts one of the following:

BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_char_index: number

file_id: string

start_char_index: number

type: "char_location"

Accepts one of the following:

"char_location"

BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_page_number: number

file_id: string

start_page_number: number

type: "page_location"

Accepts one of the following:

"page_location"

BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_block_index: number

file_id: string

start_block_index: number

type: "content_block_location"

Accepts one of the following:

"content_block_location"

BetaCitationsWebSearchResultLocation = object { 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

BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }

cited_text: string

end_block_index: number

search_result_index: number

source: string

start_block_index: number

title: string

type: "search_result_location"

Accepts one of the following:

"search_result_location"

text: string

type: "text"

Accepts one of the following:

"text"

BetaThinkingBlock = object { signature, thinking, type }

signature: string

thinking: string

type: "thinking"

Accepts one of the following:

"thinking"

BetaRedactedThinkingBlock = object { data, type }

data: string

type: "redacted_thinking"

Accepts one of the following:

"redacted_thinking"

BetaToolUseBlock = object { id, input, name, 2 more }

id: string

input: map[unknown]

type: "tool_use"

Accepts one of the following:

"tool_use"

caller: optional BetaDirectCaller { type } or BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

BetaDirectCaller = object { type }

Tool invocation directly from the model.

type: "direct"

Accepts one of the following:

"direct"

BetaServerToolCaller = object { 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"

BetaServerToolUseBlock = object { id, caller, input, 2 more }

id: string

caller: BetaDirectCaller { type } or BetaServerToolCaller { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

BetaDirectCaller = object { type }

Tool invocation directly from the model.

type: "direct"

Accepts one of the following:

"direct"

BetaServerToolCaller = object { 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: map[unknown]

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"

BetaWebSearchToolResultBlock = object { content, tool_use_id, type }

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

BetaWebSearchToolResultError = object { 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"

UnionMember1 = array of 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"

BetaWebFetchToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaWebFetchToolResultErrorBlock = object { 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"

BetaWebFetchBlock = object { content, retrieved_at, type, url }

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

citations: BetaCitationConfig { enabled }

Citation configuration for the document

enabled: boolean

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

Accepts one of the following:

BetaBase64PDFSource = object { 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"

BetaPlainTextSource = object { 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"

BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

BetaCodeExecutionToolResultError = object { 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"

BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }

content: array of BetaCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "code_execution_output"

Accepts one of the following:

"code_execution_output"

return_code: number

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"

BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaBashCodeExecutionToolResultError = object { error_code, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

Accepts one of the following:

"bash_code_execution_tool_result_error"

BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }

content: array of BetaBashCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "bash_code_execution_output"

Accepts one of the following:

"bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

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"

BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }

Accepts one of the following:

BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"file_not_found"

error_message: string

type: "text_editor_code_execution_tool_result_error"

Accepts one of the following:

"text_editor_code_execution_tool_result_error"

BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }

content: string

file_type: "text" or "image" or "pdf"

Accepts one of the following:

"text"

"image"

"pdf"

num_lines: number

start_line: number

total_lines: number

type: "text_editor_code_execution_view_result"

Accepts one of the following:

"text_editor_code_execution_view_result"

BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }

is_file_update: boolean

type: "text_editor_code_execution_create_result"

Accepts one of the following:

"text_editor_code_execution_create_result"

BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }

lines: array of string

new_lines: number

new_start: number

old_lines: number

old_start: number

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"

BetaToolSearchToolResultBlock = object { content, tool_use_id, type }

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

Accepts one of the following:

BetaToolSearchToolResultError = object { error_code, error_message, type }

error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

error_message: string

type: "tool_search_tool_result_error"

Accepts one of the following:

"tool_search_tool_result_error"

BetaToolSearchToolSearchResultBlock = object { tool_references, type }

tool_references: array of 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"

BetaMCPToolUseBlock = object { id, input, name, 2 more }

id: string

input: map[unknown]

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"

BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }

content: string or array of BetaTextBlock { citations, text, type }

Accepts one of the following:

UnionMember0 = string

BetaMCPToolResultBlockContent = array of BetaTextBlock { citations, text, type }

citations: array of BetaTextCitation

Citations supporting the text block.

Accepts one of the following:

BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_char_index: number

file_id: string

start_char_index: number

type: "char_location"

Accepts one of the following:

"char_location"

BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_page_number: number

file_id: string

start_page_number: number

type: "page_location"

Accepts one of the following:

"page_location"

BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string

end_block_index: number

file_id: string

start_block_index: number

type: "content_block_location"

Accepts one of the following:

"content_block_location"

BetaCitationsWebSearchResultLocation = object { 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

BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }

cited_text: string

end_block_index: number

search_result_index: number

source: string

start_block_index: number

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

tool_use_id: string

type: "mcp_tool_result"

Accepts one of the following:

"mcp_tool_result"

BetaContainerUploadBlock = object { file_id, type }

Response model for a file uploaded to the container.

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:

BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }

cleared_input_tokens: number

Number of input tokens cleared by this edit.

minimum0

cleared_tool_uses: number

Number of tool uses that were cleared.

minimum0

type: "clear_tool_uses_20250919"

The type of context management edit applied.

Accepts one of the following:

"clear_tool_uses_20250919"

BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }

cleared_input_tokens: number

Number of input tokens cleared by this edit.

minimum0

cleared_thinking_turns: number

Number of thinking turns that were cleared.

minimum0

type: "clear_thinking_20251015"

The type of context management edit applied.

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:

UnionMember0 = "claude-opus-4-5-20251101" or "claude-opus-4-5" or "claude-3-7-sonnet-latest" or 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

UnionMember1 = 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: number

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

minimum0

ephemeral_5m_input_tokens: number

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

minimum0

cache_creation_input_tokens: number

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

minimum0

cache_read_input_tokens: number

The number of input tokens read from the cache.

minimum0

input_tokens: number

The number of input tokens which were used.

minimum0

output_tokens: number

The number of output tokens which were used.

minimum0

server_tool_use: BetaServerToolUsage { web_fetch_requests, web_search_requests }

The number of server tool requests.

web_fetch_requests: number

The number of web fetch tool requests.

minimum0

web_search_requests: number

The number of web search tool requests.

minimum0

service_tier: "standard" or "priority" or "batch"

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

Accepts one of the following:

"standard"

"priority"

"batch"

type: "succeeded"

Accepts one of the following:

"succeeded"

Batches

Create a Message Batch

Retrieve a Message Batch

List Message Batches

Cancel a Message Batch

Delete a Message Batch

Retrieve Message Batch results

ModelsExpand Collapse