Batches

Cancel a Message Batch

beta().messages().batches().cancel(, ) : BetaMessageBatch

post/v1/messages/batches/{message_batch_id}/cancel?beta=true

Create a Message Batch

beta().messages().batches().create(, ) : BetaMessageBatch

post/v1/messages/batches?beta=true

Delete a Message Batch

beta().messages().batches().delete(, ) : BetaDeletedMessageBatch

delete/v1/messages/batches/{message_batch_id}?beta=true

List Message Batches

beta().messages().batches().list(, ) : BatchListPage

get/v1/messages/batches?beta=true

Retrieve Message Batch results

beta().messages().batches().resultsStreaming(, ) : BetaMessageBatchIndividualResponse

get/v1/messages/batches/{message_batch_id}/results?beta=true

Retrieve a Message Batch

beta().messages().batches().retrieve(, ) : BetaMessageBatch

get/v1/messages/batches/{message_batch_id}?beta=true

ModelsExpand Collapse

class BetaDeletedMessageBatch:

id: String

ID of the Message Batch.

type: JsonValue;

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

Accepts one of the following:

MESSAGE_BATCH_DELETED("message_batch_deleted")

class BetaMessageBatch:

id: String

Unique object identifier.

The format and length of IDs may change over time.

archivedAt: Optional<LocalDateTime>

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

formatdate-time

cancelInitiatedAt: Optional<LocalDateTime>

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

formatdate-time

createdAt: LocalDateTime

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

formatdate-time

endedAt: Optional<LocalDateTime>

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

expiresAt: LocalDateTime

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

processingStatus: ProcessingStatus

Processing status of the Message Batch.

Accepts one of the following:

IN_PROGRESS("in_progress")

CANCELING("canceling")

ENDED("ended")

requestCounts: BetaMessageBatchRequestCounts

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

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

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

errored: Long

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

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

expired: Long

Number of requests in the Message Batch that have expired.

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

processing: Long

Number of requests in the Message Batch that are processing.

succeeded: Long

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

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

resultsUrl: Optional<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: JsonValue;

Object type.

For Message Batches, this is always "message_batch".

Accepts one of the following:

MESSAGE_BATCH("message_batch")

class BetaMessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchErroredResult:

error: BetaErrorResponse

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

message: String

type: JsonValue;

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

requestId: Optional<String>

type: JsonValue;

Accepts one of the following:

ERROR("error")

type: JsonValue;

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class BetaMessageBatchIndividualResponse:

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

customId: 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: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

Skill ID

maxLength64

minLength1

type: Type

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

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<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: Optional<List<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:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError:

errorCode: BetaWebSearchToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

List<BetaWebSearchResultBlock>

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

content: Content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

errorCode: BetaWebFetchToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError:

errorCode: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

content: Content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

errorCode: ErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

content: Content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

errorCode: ErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")

High-performance model with early extended thinking

CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")

High-performance model with early extended thinking

CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")

Fastest and most compact model for near-instant responsiveness

CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")

Our fastest model

CLAUDE_HAIKU_4_5("claude-haiku-4-5")

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

CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")

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

CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")

High-performance model with extended thinking

CLAUDE_SONNET_4_0("claude-sonnet-4-0")

High-performance model with extended thinking

CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")

High-performance model with extended thinking

CLAUDE_SONNET_4_5("claude-sonnet-4-5")

Our best model for real-world agents and coding

CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")

Our best model for real-world agents and coding

CLAUDE_OPUS_4_0("claude-opus-4-0")

Our most capable model

CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")

Our most capable model

CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")

Our most capable model

CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")

Our most capable model

CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")

Excels at writing and complex tasks

CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")

Excels at writing and complex tasks

CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")

Our previous most fast and cost-effective

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

stopSequence: Optional<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: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

SUCCEEDED("succeeded")

class BetaMessageBatchErroredResult:

error: BetaErrorResponse

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

message: String

type: JsonValue;

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

requestId: Optional<String>

type: JsonValue;

Accepts one of the following:

ERROR("error")

type: JsonValue;

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class BetaMessageBatchRequestCounts:

canceled: Long

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

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

errored: Long

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

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

expired: Long

Number of requests in the Message Batch that have expired.

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

processing: Long

Number of requests in the Message Batch that are processing.

succeeded: Long

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

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

class 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.

class BetaMessageBatchSucceededResult:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

Skill ID

maxLength64

minLength1

type: Type

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

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<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: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError:

errorCode: BetaWebSearchToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

List<BetaWebSearchResultBlock>

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

content: Content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

errorCode: BetaWebFetchToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError:

errorCode: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

content: Content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

errorCode: ErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

content: Content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

errorCode: ErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")

High-performance model with early extended thinking

CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")

High-performance model with early extended thinking

CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")

Fastest and most compact model for near-instant responsiveness

CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")

Our fastest model

CLAUDE_HAIKU_4_5("claude-haiku-4-5")

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

CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")

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

CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")

High-performance model with extended thinking

CLAUDE_SONNET_4_0("claude-sonnet-4-0")

High-performance model with extended thinking

CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")

High-performance model with extended thinking

CLAUDE_SONNET_4_5("claude-sonnet-4-5")

Our best model for real-world agents and coding

CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")

Our best model for real-world agents and coding

CLAUDE_OPUS_4_0("claude-opus-4-0")

Our most capable model

CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")

Our most capable model

CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")

Our most capable model

CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")

Our most capable model

CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")

Excels at writing and complex tasks

CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")

Excels at writing and complex tasks

CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")

Our previous most fast and cost-effective

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

stopSequence: Optional<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: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

SUCCEEDED("succeeded")

class BetaMessageBatchErroredResult:

error: BetaErrorResponse

error: BetaError

Accepts one of the following:

class BetaInvalidRequestError:

message: String

type: JsonValue;

Accepts one of the following:

INVALID_REQUEST_ERROR("invalid_request_error")

class BetaAuthenticationError:

message: String

type: JsonValue;

Accepts one of the following:

AUTHENTICATION_ERROR("authentication_error")

class BetaBillingError:

message: String

type: JsonValue;

Accepts one of the following:

BILLING_ERROR("billing_error")

class BetaPermissionError:

message: String

type: JsonValue;

Accepts one of the following:

PERMISSION_ERROR("permission_error")

class BetaNotFoundError:

message: String

type: JsonValue;

Accepts one of the following:

NOT_FOUND_ERROR("not_found_error")

class BetaRateLimitError:

message: String

type: JsonValue;

Accepts one of the following:

RATE_LIMIT_ERROR("rate_limit_error")

class BetaGatewayTimeoutError:

message: String

type: JsonValue;

Accepts one of the following:

TIMEOUT_ERROR("timeout_error")

class BetaApiError:

message: String

type: JsonValue;

Accepts one of the following:

API_ERROR("api_error")

class BetaOverloadedError:

message: String

type: JsonValue;

Accepts one of the following:

OVERLOADED_ERROR("overloaded_error")

requestId: Optional<String>

type: JsonValue;

Accepts one of the following:

ERROR("error")

type: JsonValue;

Accepts one of the following:

ERRORED("errored")

class BetaMessageBatchCanceledResult:

type: JsonValue;

Accepts one of the following:

CANCELED("canceled")

class BetaMessageBatchExpiredResult:

type: JsonValue;

Accepts one of the following:

EXPIRED("expired")

class BetaMessageBatchSucceededResult:

message: BetaMessage

id: String

Unique object identifier.

The format and length of IDs may change over time.

container: Optional<BetaContainer>

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expiresAt: LocalDateTime

The time at which the container will expire.

formatdate-time

skills: Optional<List<BetaSkill>>

Skills loaded in the container

skillId: String

Skill ID

maxLength64

minLength1

type: Type

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

Accepts one of the following:

ANTHROPIC("anthropic")

CUSTOM("custom")

version: String

Skill version or 'latest' for most recent version

maxLength64

minLength1

content: List<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: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

class BetaThinkingBlock:

signature: String

thinking: String

type: JsonValue;

Accepts one of the following:

THINKING("thinking")

class BetaRedactedThinkingBlock:

data: String

type: JsonValue;

Accepts one of the following:

REDACTED_THINKING("redacted_thinking")

class BetaToolUseBlock:

id: String

input: Input

minLength1

type: JsonValue;

Accepts one of the following:

TOOL_USE("tool_use")

class BetaServerToolUseBlock:

id: String

input: Input

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_FETCH("web_fetch")

CODE_EXECUTION("code_execution")

BASH_CODE_EXECUTION("bash_code_execution")

TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")

type: JsonValue;

Accepts one of the following:

SERVER_TOOL_USE("server_tool_use")

class BetaWebSearchToolResultBlock:

content: BetaWebSearchToolResultBlockContent

Accepts one of the following:

class BetaWebSearchToolResultError:

errorCode: BetaWebSearchToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

MAX_USES_EXCEEDED("max_uses_exceeded")

TOO_MANY_REQUESTS("too_many_requests")

QUERY_TOO_LONG("query_too_long")

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")

List<BetaWebSearchResultBlock>

encryptedContent: String

pageAge: Optional<String>

title: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT("web_search_result")

url: String

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_TOOL_RESULT("web_search_tool_result")

class BetaWebFetchToolResultBlock:

content: Content

Accepts one of the following:

class BetaWebFetchToolResultErrorBlock:

errorCode: BetaWebFetchToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

URL_TOO_LONG("url_too_long")

URL_NOT_ALLOWED("url_not_allowed")

URL_NOT_ACCESSIBLE("url_not_accessible")

UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")

TOO_MANY_REQUESTS("too_many_requests")

MAX_USES_EXCEEDED("max_uses_exceeded")

UNAVAILABLE("unavailable")

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")

class BetaWebFetchBlock:

content: BetaDocumentBlock

citations: Optional<BetaCitationConfig>

Citation configuration for the document

enabled: Boolean

source: Source

Accepts one of the following:

class BetaBase64PdfSource:

data: String

formatbyte

mediaType: JsonValue;

Accepts one of the following:

APPLICATION_PDF("application/pdf")

type: JsonValue;

Accepts one of the following:

BASE64("base64")

class BetaPlainTextSource:

data: String

mediaType: JsonValue;

Accepts one of the following:

TEXT_PLAIN("text/plain")

type: JsonValue;

Accepts one of the following:

TEXT("text")

title: Optional<String>

The title of the document

type: JsonValue;

Accepts one of the following:

DOCUMENT("document")

retrievedAt: Optional<String>

ISO 8601 timestamp when the content was retrieved

type: JsonValue;

Accepts one of the following:

WEB_FETCH_RESULT("web_fetch_result")

url: String

Fetched content URL

toolUseId: String

type: JsonValue;

Accepts one of the following:

WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")

class BetaCodeExecutionToolResultBlock:

content: BetaCodeExecutionToolResultBlockContent

Accepts one of the following:

class BetaCodeExecutionToolResultError:

errorCode: BetaCodeExecutionToolResultErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")

class BetaCodeExecutionResultBlock:

content: List<BetaCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_OUTPUT("code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_RESULT("code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")

class BetaBashCodeExecutionToolResultBlock:

content: Content

Accepts one of the following:

class BetaBashCodeExecutionToolResultError:

errorCode: ErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

OUTPUT_FILE_TOO_LARGE("output_file_too_large")

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")

class BetaBashCodeExecutionResultBlock:

content: List<BetaBashCodeExecutionOutputBlock>

fileId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")

returnCode: Long

stderr: String

stdout: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")

class BetaTextEditorCodeExecutionToolResultBlock:

content: Content

Accepts one of the following:

class BetaTextEditorCodeExecutionToolResultError:

errorCode: ErrorCode

Accepts one of the following:

INVALID_TOOL_INPUT("invalid_tool_input")

UNAVAILABLE("unavailable")

TOO_MANY_REQUESTS("too_many_requests")

EXECUTION_TIME_EXCEEDED("execution_time_exceeded")

FILE_NOT_FOUND("file_not_found")

errorMessage: Optional<String>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")

class BetaTextEditorCodeExecutionViewResultBlock:

content: String

fileType: FileType

Accepts one of the following:

TEXT("text")

IMAGE("image")

PDF("pdf")

numLines: Optional<Long>

startLine: Optional<Long>

totalLines: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")

class BetaTextEditorCodeExecutionCreateResultBlock:

isFileUpdate: Boolean

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")

class BetaTextEditorCodeExecutionStrReplaceResultBlock:

lines: Optional<List<String>>

newLines: Optional<Long>

newStart: Optional<Long>

oldLines: Optional<Long>

oldStart: Optional<Long>

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")

toolUseId: String

type: JsonValue;

Accepts one of the following:

TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")

class BetaMcpToolUseBlock:

id: String

input: Input

The name of the MCP tool

serverName: String

The name of the MCP server

type: JsonValue;

Accepts one of the following:

MCP_TOOL_USE("mcp_tool_use")

class BetaMcpToolResultBlock:

content: Content

Accepts one of the following:

String

List<BetaTextBlock>

citations: Optional<List<BetaTextCitation>>

Citations supporting the text block.

Accepts one of the following:

class BetaCitationCharLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endCharIndex: Long

fileId: Optional<String>

startCharIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CHAR_LOCATION("char_location")

class BetaCitationPageLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endPageNumber: Long

fileId: Optional<String>

startPageNumber: Long

minimum1

type: JsonValue;

Accepts one of the following:

PAGE_LOCATION("page_location")

class BetaCitationContentBlockLocation:

citedText: String

documentIndex: Long

minimum0

documentTitle: Optional<String>

endBlockIndex: Long

fileId: Optional<String>

startBlockIndex: Long

minimum0

type: JsonValue;

Accepts one of the following:

CONTENT_BLOCK_LOCATION("content_block_location")

class BetaCitationsWebSearchResultLocation:

citedText: String

encryptedIndex: String

title: Optional<String>

maxLength512

type: JsonValue;

Accepts one of the following:

WEB_SEARCH_RESULT_LOCATION("web_search_result_location")

url: String

class BetaCitationSearchResultLocation:

citedText: String

endBlockIndex: Long

searchResultIndex: Long

minimum0

source: String

startBlockIndex: Long

minimum0

title: Optional<String>

type: JsonValue;

Accepts one of the following:

SEARCH_RESULT_LOCATION("search_result_location")

text: String

maxLength5000000

minLength0

type: JsonValue;

Accepts one of the following:

TEXT("text")

isError: Boolean

toolUseId: String

type: JsonValue;

Accepts one of the following:

MCP_TOOL_RESULT("mcp_tool_result")

class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

fileId: String

type: JsonValue;

Accepts one of the following:

CONTAINER_UPLOAD("container_upload")

contextManagement: Optional<BetaContextManagementResponse>

Context management response.

Information about context management strategies applied during the request.

appliedEdits: List<AppliedEdit>

List of context management edits that were applied.

Accepts one of the following:

class BetaClearToolUses20250919EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedToolUses: Long

Number of tool uses that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")

class BetaClearThinking20251015EditResponse:

clearedInputTokens: Long

Number of input tokens cleared by this edit.

minimum0

clearedThinkingTurns: Long

Number of thinking turns that were cleared.

minimum0

type: JsonValue;

The type of context management edit applied.

Accepts one of the following:

CLEAR_THINKING_20251015("clear_thinking_20251015")

model: Model

The model that will complete your prompt.

See models for additional details and options.

Accepts one of the following:

CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")

High-performance model with early extended thinking

CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")

High-performance model with early extended thinking

CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")

Fastest and most compact model for near-instant responsiveness

CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")

Our fastest model

CLAUDE_HAIKU_4_5("claude-haiku-4-5")

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

CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")

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

CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")

High-performance model with extended thinking

CLAUDE_SONNET_4_0("claude-sonnet-4-0")

High-performance model with extended thinking

CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")

High-performance model with extended thinking

CLAUDE_SONNET_4_5("claude-sonnet-4-5")

Our best model for real-world agents and coding

CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")

Our best model for real-world agents and coding

CLAUDE_OPUS_4_0("claude-opus-4-0")

Our most capable model

CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")

Our most capable model

CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")

Our most capable model

CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")

Our most capable model

CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")

Excels at writing and complex tasks

CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")

Excels at writing and complex tasks

CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")

Our previous most fast and cost-effective

role: JsonValue;

Conversational role of the generated message.

This will always be "assistant".

Accepts one of the following:

ASSISTANT("assistant")

stopReason: Optional<BetaStopReason>

The reason that we stopped.

This may be one the following values:

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

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

Accepts one of the following:

END_TURN("end_turn")

MAX_TOKENS("max_tokens")

STOP_SEQUENCE("stop_sequence")

TOOL_USE("tool_use")

PAUSE_TURN("pause_turn")

REFUSAL("refusal")

MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")

stopSequence: Optional<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: JsonValue;

Object type.

For Messages, this is always "message".

Accepts one of the following:

MESSAGE("message")

usage: BetaUsage

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.

cacheCreation: Optional<BetaCacheCreation>

Breakdown of cached tokens by TTL

ephemeral1hInputTokens: Long

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

minimum0

ephemeral5mInputTokens: Long

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

minimum0

cacheCreationInputTokens: Optional<Long>

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

minimum0

cacheReadInputTokens: Optional<Long>

The number of input tokens read from the cache.

minimum0

inputTokens: Long

The number of input tokens which were used.

minimum0

outputTokens: Long

The number of output tokens which were used.

minimum0

serverToolUse: Optional<BetaServerToolUsage>

The number of server tool requests.

webFetchRequests: Long

The number of web fetch tool requests.

minimum0

webSearchRequests: Long

The number of web search tool requests.

minimum0

serviceTier: Optional<ServiceTier>

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

Accepts one of the following:

STANDARD("standard")

PRIORITY("priority")

BATCH("batch")

type: JsonValue;

Accepts one of the following:

SUCCEEDED("succeeded")

Batches

Cancel a Message Batch

Create a Message Batch

Delete a Message Batch

List Message Batches

Retrieve Message Batch results

Retrieve a Message Batch

ModelsExpand Collapse

Products

Features

Models

Solutions

Claude Developer Platform

Learn

Company

Help and security

Terms and policies