メッセージバッチを作成
メッセージ作成リクエストのバッチを送信します。
Message Batches APIを使用すると、複数のMessages APIリクエストを一度に処理できます。メッセージバッチが作成されると、すぐに処理が開始されます。バッチの完了には最大24時間かかる場合があります。
Message Batches APIの詳細については、ユーザーガイドをご覧ください。
Headers
The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the user-profiles beta header. Applies to every request in the batch; an individual request whose user_profile_id body field conflicts with this header is errored.
Body
requests: array of object{ 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: object{ 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: numberThe 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.
Set to 0 to populate the prompt cache without generating a response.
Different models have different maximum values for this parameter. See models for details.
messages: array of 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 or array of ContentBlockParam
array of ContentBlockParam
TextBlockParam object{ text, type, cache_control, citations }
ImageBlockParam object{ source, type, cache_control, transformations }
DocumentBlockParam object{ source, type, cache_control, 3 more }
SearchResultBlockParam object{ content, source, title, 3 more }
ThinkingBlockParam object{ signature, thinking, type }
signature: stringThe signature value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
The signature value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 invalid_request_error.
The thinking text of this block as returned by the API.
RedactedThinkingBlockParam object{ data, type }
The data value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
ToolUseBlockParam object{ id, input, name, 4 more }
ToolResultBlockParam object{ tool_use_id, type, cache_control, 3 more }
ServerToolUseBlockParam object{ id, input, name, 3 more }
WebSearchToolResultBlockParam object{ content, tool_use_id, type, 2 more }
WebFetchToolResultBlockParam object{ content, tool_use_id, type, 2 more }
CodeExecutionToolResultBlockParam object{ 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.
tool_use_id: string
cache_control: optional CacheControlEphemeral { type, ttl } or nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "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. See prompt caching pricing for details.
BashCodeExecutionToolResultBlockParam object{ content, tool_use_id, type, cache_control }
TextEditorCodeExecutionToolResultBlockParam object{ content, tool_use_id, type, cache_control }
ToolSearchToolResultBlockParam object{ content, tool_use_id, type, cache_control }
ContainerUploadBlockParam object{ 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: optional CacheControlEphemeral { type, ttl } or nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "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. See prompt caching pricing for details.
role: "user" or "assistant" or "system"
cache_control: optional CacheControlEphemeral { type, ttl } or nullTop-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: optional "5m" or "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. See prompt caching pricing for details.
container: optional MessageCreateParamsContainer or nullContainer identifier for reuse across requests.
Container identifier for reuse across requests.
ContainerParams object{ id, skills }Container parameters with skills to be loaded.
Container parameters with skills to be loaded.
Container id
skills: optional array of SkillParams { skill_id, type, version } or nullList of skills to load in the container
List of skills to load in the container
skill_id: stringSkill ID
Skill ID
type: "anthropic" or "custom"Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: optional stringSkill version or 'latest' for most recent version
Skill version or 'latest' for most recent version
Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.
metadata: optional Metadata { user_id }An object describing metadata about the request.
An object describing metadata about the request.
user_id: optional string or nullAn 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: optional 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: optional "low" or "medium" or "high" or 2 more or nullAll possible effort levels.
All possible effort levels.
format: optional JSONOutputFormat { schema, type } or nullA 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: optional "auto" or "standard_only"Determines 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: optional array of stringCustom 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: optional booleanWhether to incrementally stream the response using server-sent events.
Whether to incrementally stream the response using server-sent events.
See streaming for details.
system: optional string or array of 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 of TextBlockParam { text, type, cache_control, citations }
text: string
cache_control: optional CacheControlEphemeral { type, ttl } or nullCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
ttl: optional "5m" or "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. See prompt caching pricing for details.
citations: optional array of TextCitationParam or null
CitationCharLocationParam object{ cited_text, document_index, document_title, 3 more }
document_index: number
document_title: string or null
start_char_index: number
CitationPageLocationParam object{ cited_text, document_index, document_title, 3 more }
document_index: number
document_title: string or null
start_page_number: number
CitationContentBlockLocationParam object{ cited_text, document_index, document_title, 3 more }
cited_text: stringThe full text of the cited block range, concatenated.
The full text of the cited block range, concatenated.
Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.
document_index: number
document_title: string or null
end_block_index: numberExclusive 0-based end index of the cited block range in the source's content array.
Exclusive 0-based end index of the cited block range in the source's content array.
Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.
start_block_index: number0-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
CitationWebSearchResultLocationParam object{ cited_text, encrypted_index, title, 2 more }
title: string or null
url: string
CitationSearchResultLocationParam object{ cited_text, end_block_index, search_result_index, 4 more }
cited_text: stringThe full text of the cited block range, concatenated.
The full text of the cited block range, concatenated.
Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.
end_block_index: numberExclusive 0-based end index of the cited block range in the source's content array.
Exclusive 0-based end index of the cited block range in the source's content array.
Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.
search_result_index: number0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.
0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.
Counted separately from document_index; server-side web search results are not included in this count.
start_block_index: number0-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
thinking: optional 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.
tool_choice: optional 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.
tools: optional array of ToolUnionDefinitions 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.
Tool object{ input_schema, name, allowed_callers, 7 more }
ToolBash20250124 object{ name, type, allowed_callers, 4 more }
CodeExecutionTool20250522 object{ name, type, allowed_callers, 3 more }
CodeExecutionTool20250825 object{ name, type, allowed_callers, 3 more }
CodeExecutionTool20260120 object{ 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).
CodeExecutionTool20260521 object{ name, type, allowed_callers, 3 more }Code execution tool with REPL state persistence.
Code execution tool with REPL state persistence.
BrowserToolset20260801 object{ type, cache_control, configs }The browser toolset: a single tools[] entry (carrying no
name) that declares the browser tool family. The model is served
the family's tool with any members disabled via configs removed
from its schema.
The browser toolset: a single tools[] entry (carrying no
name) that declares the browser tool family. The model is served
the family's tool with any members disabled via configs removed
from its schema.
MemoryTool20250818 object{ name, type, allowed_callers, 4 more }
ComputerToolset20260801 object{ type, cache_control, configs }The computer toolset: a single tools[] entry (carrying no
name) that declares the computer tool family. The model is
served the family's tool with any members disabled via configs
removed from its schema. Every member is enabled by default, zoom
included. The single-tool options display_number and
enable_zoom are not fields of a toolset entry — it carries only
type, configs, and cache_control; zoom is controlled
via configs.zoom.enabled.
The computer toolset: a single tools[] entry (carrying no
name) that declares the computer tool family. The model is
served the family's tool with any members disabled via configs
removed from its schema. Every member is enabled by default, zoom
included. The single-tool options display_number and
enable_zoom are not fields of a toolset entry — it carries only
type, configs, and cache_control; zoom is controlled
via configs.zoom.enabled.
ToolTextEditor20250124 object{ name, type, allowed_callers, 4 more }
ToolTextEditor20250429 object{ name, type, allowed_callers, 4 more }
ToolTextEditor20250728 object{ name, type, allowed_callers, 5 more }
WebSearchTool20250305 object{ name, type, allowed_callers, 7 more }
WebFetchTool20250910 object{ name, type, allowed_callers, 8 more }
WebSearchTool20260209 object{ name, type, allowed_callers, 7 more }
WebFetchTool20260209 object{ name, type, allowed_callers, 8 more }
WebFetchTool20260309 object{ name, type, allowed_callers, 9 more }Web fetch tool with use_cache parameter for bypassing cached content.
Web fetch tool with use_cache parameter for bypassing cached content.
WebSearchTool20260318 object{ name, type, allowed_callers, 8 more }
WebFetchTool20260318 object{ name, type, allowed_callers, 10 more }
ToolSearchToolBm25_20251119 object{ name, type, allowed_callers, 3 more }
ToolSearchToolRegex20251119 object{ name, type, allowed_callers, 3 more }
temperature: optional numberDeprecatedAmount 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.
top_k: optional numberDeprecatedOnly 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.
top_p: optional numberDeprecatedUse 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.
Recommended for advanced use cases only.
Returns
MessageBatch object{ id, archived_at, cancel_initiated_at, 7 more }
curl https://api.anthropic.com/v1/messages/batches \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"requests": [
{
"custom_id": "my-custom-id-1",
"params": {
"max_tokens": 1024,
"messages": [
{
"content": "Hello, world",
"role": "user"
}
],
"model": "claude-opus-5"
}
}
]
}'{
"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"
}