Create a Message Batch
Send a batch of Message creation requests.
The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete.
Learn more about the Message Batches API in our user guide
ParametersExpand Collapse
requests: Array[{ custom_id, params}]List of requests for prompt completion. Each is an individual request to create a Message.
List of requests for prompt completion. Each is an individual request to create a Message.
custom_id: StringDeveloper-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.
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.
params: { max_tokens, messages, model, 15 more}Messages API creation parameters for the individual request.
Messages API creation parameters for the individual request.
See the Messages API reference for full documentation on available parameters.
max_tokens: IntegerThe maximum number of tokens to generate before stopping.
The maximum number of tokens to generate before stopping.
Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
Different models have different maximum values for this parameter. See models for details.
messages: Array[MessageParam { content, role } ]Input messages.
Input messages.
Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.
Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.
If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.
Example with a single user message:
[{"role": "user", "content": "Hello, Claude"}]
Example with multiple conversational turns:
[
{"role": "user", "content": "Hello there."},
{"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
{"role": "user", "content": "Can you explain LLMs in plain English?"},
]
Example with a partially-filled response from Claude:
[
{"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
{"role": "assistant", "content": "The best answer is ("},
]
Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:
{"role": "user", "content": "Hello, Claude"}
{"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
See input examples.
Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.
There is a limit of 100,000 messages in a single request.
content: String | Array[ContentBlockParam]
Array[ContentBlockParam]
class TextBlockParam { text, type, cache_control, citations }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
class ImageBlockParam { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
class Base64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
class URLImageSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class DocumentBlockParam { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }
class Base64PDFSource { data, media_type, type }
class PlainTextSource { data, media_type, type }
class ContentBlockSource { content, type }
content: String | Array[ContentBlockSourceContent]
Array[ContentBlockSourceContent]
class TextBlockParam { text, type, cache_control, citations }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
class ImageBlockParam { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
class Base64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
class URLImageSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class URLPDFSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled }
class SearchResultBlockParam { content, source, title, 3 more }
content: Array[TextBlockParam { text, type, cache_control, citations } ]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled }
class ThinkingBlockParam { signature, thinking, type }
class RedactedThinkingBlockParam { data, type }
class ToolUseBlockParam { id, input, name, 3 more }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller_: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120 { tool_id, type }
class ToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: String | Array[TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | SearchResultBlockParam { content, source, title, 3 more } | 2 more]
Array[TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | SearchResultBlockParam { content, source, title, 3 more } | 2 more]
class TextBlockParam { text, type, cache_control, citations }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
class ImageBlockParam { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
class Base64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
class URLImageSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class SearchResultBlockParam { content, source, title, 3 more }
content: Array[TextBlockParam { text, type, cache_control, citations } ]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled }
class DocumentBlockParam { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }
class Base64PDFSource { data, media_type, type }
class PlainTextSource { data, media_type, type }
class ContentBlockSource { content, type }
content: String | Array[ContentBlockSourceContent]
Array[ContentBlockSourceContent]
class TextBlockParam { text, type, cache_control, citations }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
class ImageBlockParam { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
class Base64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
class URLImageSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class URLPDFSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled }
class ToolReferenceBlockParam { tool_name, type, cache_control } Tool reference block that can be included in tool_result content.
Tool reference block that can be included in tool_result content.
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class ServerToolUseBlockParam { id, input, name, 3 more }
name: :web_search | :web_fetch | :code_execution | 4 more
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller_: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120 { tool_id, type }
class WebSearchToolResultBlockParam { content, tool_use_id, type, 2 more }
content: WebSearchToolResultBlockParamContent
Array[WebSearchResultBlockParam { encrypted_content, title, type, 2 more } ]
class WebSearchToolRequestError { error_code, type }
error_code: WebSearchToolResultErrorCode
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller_: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120 { tool_id, type }
class WebFetchToolResultBlockParam { content, tool_use_id, type, 2 more }
content: WebFetchToolResultErrorBlockParam { error_code, type } | WebFetchBlockParam { content, type, url, retrieved_at }
class WebFetchToolResultErrorBlockParam { error_code, type }
error_code: WebFetchToolResultErrorCode
class WebFetchBlockParam { content, type, url, retrieved_at }
content: DocumentBlockParam { source, type, cache_control, 3 more }
source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }
class Base64PDFSource { data, media_type, type }
class PlainTextSource { data, media_type, type }
class ContentBlockSource { content, type }
content: String | Array[ContentBlockSourceContent]
Array[ContentBlockSourceContent]
class TextBlockParam { text, type, cache_control, citations }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
class ImageBlockParam { source, type, cache_control }
source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
class Base64ImageSource { data, media_type, type }
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
class URLImageSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class URLPDFSource { type, url }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled }
Fetched content URL
ISO 8601 timestamp when the content was retrieved
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller_: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type } Tool invocation directly from the model.
Tool invocation directly from the model.
class DirectCaller { type } Tool invocation directly from the model.
Tool invocation directly from the model.
class ServerToolCaller { tool_id, type } Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
class ServerToolCaller20260120 { tool_id, type }
class CodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
class CodeExecutionToolResultErrorParam { error_code, type }
error_code: CodeExecutionToolResultErrorCode
class CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: Array[CodeExecutionOutputBlockParam { file_id, type } ]
class EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more } Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
content: Array[CodeExecutionOutputBlockParam { file_id, type } ]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: BashCodeExecutionToolResultErrorParam { error_code, type } | BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
class BashCodeExecutionToolResultErrorParam { error_code, type }
error_code: BashCodeExecutionToolResultErrorCode
class BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: Array[BashCodeExecutionOutputBlockParam { file_id, type } ]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class TextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
content: TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
class TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
error_code: TextEditorCodeExecutionToolResultErrorCode
class TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
file_type: :text | :image | :pdf
class TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
class TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class ToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
content: ToolSearchToolResultErrorParam { error_code, type } | ToolSearchToolSearchResultBlockParam { tool_references, type }
class ToolSearchToolResultErrorParam { error_code, type }
error_code: ToolSearchToolResultErrorCode
class ToolSearchToolSearchResultBlockParam { tool_references, type }
tool_references: Array[ToolReferenceBlockParam { tool_name, type, cache_control } ]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class ContainerUploadBlockParam { file_id, type, cache_control } A content block that represents a file to be uploaded to the container
Files uploaded via this block will be available in the container's input directory.
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
role: :user | :assistant
model: ModelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
:"claude-opus-4-6" | :"claude-sonnet-4-6" | :"claude-opus-4-5-20251101" | 19 moreThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Most intelligent model for building agents and coding
Frontier intelligence at scale — built for coding, agents, and enterprise workflows
Premium model combining maximum intelligence with practical performance
Premium model combining maximum intelligence with practical performance
High-performance model with early extended thinking
High-performance model with early extended thinking
Fastest and most compact model for near-instant responsiveness
Our fastest model
Hybrid model, capable of near-instant responses and extended thinking
Hybrid model, capable of near-instant responses and extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
High-performance model with extended thinking
Our best model for real-world agents and coding
Our best model for real-world agents and coding
Our most capable model
Our most capable model
Our most capable model
Our most capable model
Excels at writing and complex tasks
Excels at writing and complex tasks
Our previous most fast and cost-effective
cache_control: CacheControlEphemeral { type, ttl } Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Container identifier for reuse across requests.
Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.
metadata: Metadata { user_id } An object describing metadata about the request.
An object describing metadata about the request.
user_id: StringAn external identifier for the user who is associated with the request.
An external identifier for the user who is associated with the request.
This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.
output_config: OutputConfig { effort, format_ } Configuration options for the model's output, such as the output format.
Configuration options for the model's output, such as the output format.
effort: :low | :medium | :high | :maxAll possible effort levels.
All possible effort levels.
format_: JSONOutputFormat { schema, type } A schema to specify Claude's output format in responses. See structured outputs
A schema to specify Claude's output format in responses. See structured outputs
The JSON schema of the format
service_tier: :auto | :standard_onlyDetermines whether to use priority capacity (if available) or standard capacity for this request.
Determines whether to use priority capacity (if available) or standard capacity for this request.
Anthropic offers different levels of service for your API requests. See service-tiers for details.
stop_sequences: Array[String]Custom text sequences that will cause the model to stop generating.
Custom text sequences that will cause the model to stop generating.
Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".
If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.
stream: boolWhether to incrementally stream the response using server-sent events.
Whether to incrementally stream the response using server-sent events.
See streaming for details.
system_: String | Array[TextBlockParam { text, type, cache_control, citations } ]System prompt.
System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
Array[TextBlockParam { text, type, cache_control, citations } ]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Array[TextCitationParam]
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
temperature: FloatAmount of randomness injected into the response.
Amount of randomness injected into the response.
Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
Note that even with temperature of 0.0, the results will not be fully deterministic.
thinking: ThinkingConfigParamConfiguration for enabling Claude's extended thinking.
Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
class ThinkingConfigEnabled { budget_tokens, type }
budget_tokens: IntegerDetermines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
class ThinkingConfigDisabled { type }
class ThinkingConfigAdaptive { type }
tool_choice: ToolChoiceHow the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
class ToolChoiceAuto { type, disable_parallel_tool_use } The model will automatically decide whether to use tools.
The model will automatically decide whether to use tools.
disable_parallel_tool_use: boolWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class ToolChoiceAny { type, disable_parallel_tool_use } The model will use any available tools.
The model will use any available tools.
disable_parallel_tool_use: boolWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class ToolChoiceTool { name, type, disable_parallel_tool_use } The model will use the specified tool with tool_choice.name.
The model will use the specified tool with tool_choice.name.
The name of the tool to use.
disable_parallel_tool_use: boolWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class ToolChoiceNone { type } The model will not be allowed to use tools.
The model will not be allowed to use tools.
tools: Array[ToolUnion]Definitions of tools that the model may use.
Definitions of tools that the model may use.
If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.
There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).
Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined tools as:
[
{
"name": "get_stock_price",
"description": "Get the current stock price for a given ticker symbol.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}
]
And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:
[
{
"type": "tool_use",
"id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"name": "get_stock_price",
"input": { "ticker": "^GSPC" }
}
]
You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:
[
{
"type": "tool_result",
"tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
"content": "259.75 USD"
}
]
Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
class Tool { input_schema, name, allowed_callers, 7 more }
input_schema: { type, properties, required}JSON schema for this tool's input.
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
name: StringName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
description: StringDescription of what this tool does.
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
When true, guarantees schema validation on tool names and inputs
class ToolBash20250124 { name, type, allowed_callers, 4 more }
name: :bashName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
name: :code_executionName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
name: :code_executionName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionTool20260120 { name, type, allowed_callers, 3 more } Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
name: :code_executionName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class MemoryTool20250818 { name, type, allowed_callers, 4 more }
name: :memoryName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolTextEditor20250124 { name, type, allowed_callers, 4 more }
name: :str_replace_editorName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolTextEditor20250429 { name, type, allowed_callers, 4 more }
name: :str_replace_based_edit_toolName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolTextEditor20250728 { name, type, allowed_callers, 5 more }
name: :str_replace_based_edit_toolName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
When true, guarantees schema validation on tool names and inputs
class WebSearchTool20250305 { name, type, allowed_callers, 7 more }
name: :web_searchName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
user_location: UserLocation { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
class WebFetchTool20250910 { name, type, allowed_callers, 8 more }
name: :web_fetchName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
List of domains to allow fetching from
List of domains to block fetching from
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled } Citations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
class WebSearchTool20260209 { name, type, allowed_callers, 7 more }
name: :web_searchName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
user_location: UserLocation { type, city, country, 2 more } Parameters for the user's location. Used to provide more relevant search results.
Parameters for the user's location. Used to provide more relevant search results.
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
class WebFetchTool20260209 { name, type, allowed_callers, 8 more }
name: :web_fetchName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
List of domains to allow fetching from
List of domains to block fetching from
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: CitationsConfigParam { enabled } Citations configuration for fetched documents. Citations are disabled by default.
Citations configuration for fetched documents. Citations are disabled by default.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
class ToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
name: :tool_search_tool_bm25Name of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :tool_search_tool_bm25_20251119 | :tool_search_tool_bm25
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
name: :tool_search_tool_regexName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
type: :tool_search_tool_regex_20251119 | :tool_search_tool_regex
allowed_callers: Array[:direct | :code_execution_20250825 | :code_execution_20260120]
cache_control: CacheControlEphemeral { type, ttl } Create a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: :"5m" | :"1h"The time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
top_k: IntegerOnly sample from the top K options for each subsequent token.
Only sample from the top K options for each subsequent token.
Used to remove "long tail" low probability responses. Learn more technical details here.
Recommended for advanced use cases only. You usually only need to use temperature.
top_p: FloatUse nucleus sampling.
Use nucleus sampling.
In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
Recommended for advanced use cases only. You usually only need to use temperature.
ReturnsExpand Collapse
class MessageBatch { id, archived_at, cancel_initiated_at, 7 more }
id: StringUnique object identifier.
Unique object identifier.
The format and length of IDs may change over time.
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
RFC 3339 datetime string representing the time at which the Message Batch was created.
ended_at: TimeRFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
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.
RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
processing_status: :in_progress | :canceling | :endedProcessing status of the Message Batch.
Processing status of the Message Batch.
request_counts: MessageBatchRequestCounts { canceled, errored, expired, 2 more } Tallies requests within the Message Batch, categorized by their status.
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: IntegerNumber of requests in the Message Batch that have been canceled.
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: IntegerNumber of requests in the Message Batch that encountered an error.
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: IntegerNumber of requests in the Message Batch that have expired.
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
Number of requests in the Message Batch that are processing.
succeeded: IntegerNumber of requests in the Message Batch that have completed successfully.
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: StringURL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.
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_batchObject type.
Object type.
For Message Batches, this is always "message_batch".
require "anthropic"
anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")
message_batch = anthropic.messages.batches.create(
requests: [
{
custom_id: "my-custom-id-1",
params: {max_tokens: 1024, messages: [{content: "Hello, world", role: :user}], model: :"claude-opus-4-6"}
}
]
)
puts(message_batch){
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"archived_at": "2024-08-20T18:37:24.100435Z",
"cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
"created_at": "2024-08-20T18:37:24.100435Z",
"ended_at": "2024-08-20T18:37:24.100435Z",
"expires_at": "2024-08-20T18:37:24.100435Z",
"processing_status": "in_progress",
"request_counts": {
"canceled": 10,
"errored": 30,
"expired": 10,
"processing": 100,
"succeeded": 50
},
"results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
"type": "message_batch"
}Returns Examples
{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"archived_at": "2024-08-20T18:37:24.100435Z",
"cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
"created_at": "2024-08-20T18:37:24.100435Z",
"ended_at": "2024-08-20T18:37:24.100435Z",
"expires_at": "2024-08-20T18:37:24.100435Z",
"processing_status": "in_progress",
"request_counts": {
"canceled": 10,
"errored": 30,
"expired": 10,
"processing": 100,
"succeeded": 50
},
"results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
"type": "message_batch"
}