Crear un lote de mensajes
Envía un lote de solicitudes de creación de mensajes.
La API de Message Batches puede usarse para procesar múltiples solicitudes de la API de Messages a la vez. Una vez creado un lote de mensajes, comienza a procesarse de inmediato. Los lotes pueden tardar hasta 24 horas en completarse.
Obtén más información sobre la API de Message Batches en nuestra guía de usuario
Parameters
BatchCreateParams params
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.
Optional<String> workspaceIdHeader parameterOptional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).
Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).
Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
List<Request> requestsList 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.
String customIdDeveloper-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 paramsMessages 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.
long maxTokensThe 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.
List<MessageParam> messagesInput 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial assistant response returns a 400 error. See Prefill not supported.
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, for models that support prefill:
[
{"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 content
List<ContentBlockParam>
class TextBlockParam { type = "text"; text; cacheControl; citations; }
class ImageBlockParam { type = "image"; source; cacheControl; transformations; }
class DocumentBlockParam { type = "document"; source; cacheControl; /* 3 more */ }
class SearchResultBlockParam { type = "search_result"; content; source; /* 3 more */ }
class ThinkingBlockParam { type = "thinking"; signature; thinking; }
String signatureThe 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.
class RedactedThinkingBlockParam { type = "redacted_thinking"; data; }
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.
class ToolUseBlockParam { type = "tool_use"; id; input; /* 4 more */ }
class ToolResultBlockParam { type = "tool_result"; toolUseId; cacheControl; /* 3 more */ }
class ServerToolUseBlockParam { type = "server_tool_use"; id; input; /* 3 more */ }
class WebSearchToolResultBlockParam { type = "web_search_tool_result"; content; toolUseId; /* 2 more */ }
class WebFetchToolResultBlockParam { type = "web_fetch_tool_result"; content; toolUseId; /* 2 more */ }
class CodeExecutionToolResultBlockParam { type = "code_execution_tool_result"; content; toolUseId; cacheControl; }
String toolUseId
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
class BashCodeExecutionToolResultBlockParam { type = "bash_code_execution_tool_result"; content; toolUseId; cacheControl; }
class TextEditorCodeExecutionToolResultBlockParam { type = "text_editor_code_execution_tool_result"; content; toolUseId; cacheControl; }
class ToolSearchToolResultBlockParam { type = "tool_search_tool_result"; content; toolUseId; cacheControl; }
class ContainerUploadBlockParam { type = "container_upload"; fileId; cacheControl; }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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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 role
Model modelThe model that will complete your prompt.
The model that will complete your prompt.
See models for additional details and options.
Optional<CacheControlEphemeral> cacheControlTop-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.
Optional<Ttl> ttlThe 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.
Optional<MessageCreateParamsContainer> containerContainer identifier for reuse across requests.
Container identifier for reuse across requests.
class ContainerParams { id; skills; }Container parameters with skills to be loaded.
Container parameters with skills to be loaded.
Container id
Optional<List<SkillParams>> skillsList of skills to load in the container
List of skills to load in the container
Type typeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
String skillIdSkill ID
Skill ID
Optional<String> versionSkill version or 'latest' for most recent version
Skill version or 'latest' for most recent version
Optional<DiagnosticsParam> diagnosticsRequest-level diagnostics. Supply previous_message_id to have the response include diagnostics.cache_miss_reason explaining any prompt-cache divergence from that prior request.
Request-level diagnostics. Supply previous_message_id to have the response include diagnostics.cache_miss_reason explaining any prompt-cache divergence from that prior request.
Optional<String> previousMessageIdThe id (msg_...) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns diagnostics.cache_miss_reason when the prompt-cache prefix could not be reused. Pass null on the first turn to opt in without a prior message to compare.
The id (msg_...) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns diagnostics.cache_miss_reason when the prompt-cache prefix could not be reused. Pass null on the first turn to opt in without a prior message to compare.
Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.
Optional<Metadata> metadataAn object describing metadata about the request.
An object describing metadata about the request.
Optional<String> userIdAn 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.
Optional<OutputConfig> outputConfigConfiguration options for the model's output, such as the output format.
Configuration options for the model's output, such as the output format.
Optional<Effort> effortHow much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
Valid values are low, medium, high, xhigh, or max.
Optional<JsonOutputFormat> formatA 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
Optional<ServiceTier> serviceTierDetermines 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.
Optional<Speed> speedThe inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.
Some models require the fast-mode-2026-02-01 beta header for any speed value. See fast mode for which models.
Optional<List<String>> stopSequencesCustom 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.
Optional<Boolean> streamWhether to incrementally stream the response using server-sent events. When true, SDKs return a raw event stream.
Whether to incrementally stream the response using server-sent events. When true, SDKs return a raw event stream.
In the TypeScript, Python and Ruby SDKs, the recommended way to stream is messages.stream(). It sets stream for you and accumulates the events into the final message. See Streaming with SDKs for an example in each language.
Optional<System> systemSystem 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.
List<TextBlockParam>
String text
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<List<TextCitationParam>> citations
class CitationCharLocationParam { type = "char_location"; citedText; documentIndex; /* 3 more */ }
long documentIndex
Optional<String> documentTitle
long startCharIndex
class CitationPageLocationParam { type = "page_location"; citedText; documentIndex; /* 3 more */ }
long documentIndex
Optional<String> documentTitle
long startPageNumber
class CitationContentBlockLocationParam { type = "content_block_location"; citedText; documentIndex; /* 3 more */ }
String citedTextThe 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.
long documentIndex
Optional<String> documentTitle
long endBlockIndexExclusive 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.
long startBlockIndex0-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.
class CitationWebSearchResultLocationParam { type = "web_search_result_location"; citedText; encryptedIndex; /* 2 more */ }
Optional<String> title
String url
class CitationSearchResultLocationParam { type = "search_result_location"; citedText; endBlockIndex; /* 4 more */ }
String citedTextThe 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.
long endBlockIndexExclusive 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.
long searchResultIndex0-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.
long startBlockIndex0-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.
Optional<ThinkingConfigParam> thinkingConfiguration for Claude's thinking.
Configuration for Claude's thinking.
With {"type": "adaptive"}, Claude decides when and how much to think. With {"type": "enabled"} (manual extended thinking), you set a budget_tokens of at least 1,024. Thinking tokens count toward your max_tokens limit.
Which type values are accepted, and what happens when you omit thinking, depend on the model. See thinking for each model's behavior.
Optional<ToolChoice> 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.
Optional<List<ToolUnion>> toolsDefinitions 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 { type; inputSchema; name; /* 7 more */ }
class ToolBash20250124 { type = "bash_20250124"; name; allowedCallers; /* 4 more */ }
class CodeExecutionTool20250522 { type = "code_execution_20250522"; name; allowedCallers; /* 3 more */ }
class CodeExecutionTool20250825 { type = "code_execution_20250825"; name; allowedCallers; /* 3 more */ }
class CodeExecutionTool20260120 { type = "code_execution_20260120"; name; allowedCallers; /* 3 more */ }Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
class CodeExecutionTool20260521 { type = "code_execution_20260521"; name; allowedCallers; /* 3 more */ }Code execution tool with REPL state persistence.
Code execution tool with REPL state persistence.
class BrowserToolset20260801 { type = "browser_toolset_20260801"; cacheControl; 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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<BrowserToolsetConfigs> configsSparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
class MemoryTool20250818 { type = "memory_20250818"; name; allowedCallers; /* 4 more */ }
class ComputerToolset20260801 { type = "computer_toolset_20260801"; cacheControl; 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.
Optional<CacheControlEphemeral> cacheControlCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
Optional<Ttl> ttlThe 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.
Optional<ComputerToolsetConfigs> configsSparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
class ToolTextEditor20250124 { type = "text_editor_20250124"; name; allowedCallers; /* 4 more */ }
class ToolTextEditor20250429 { type = "text_editor_20250429"; name; allowedCallers; /* 4 more */ }
class ToolTextEditor20250728 { type = "text_editor_20250728"; name; allowedCallers; /* 5 more */ }
class WebSearchTool20250305 { type = "web_search_20250305"; name; allowedCallers; /* 7 more */ }
class WebFetchTool20250910 { type = "web_fetch_20250910"; name; allowedCallers; /* 9 more */ }
class WebSearchTool20260209 { type = "web_search_20260209"; name; allowedCallers; /* 7 more */ }
class WebFetchTool20260209 { type = "web_fetch_20260209"; name; allowedCallers; /* 9 more */ }
class WebFetchTool20260309 { type = "web_fetch_20260309"; name; allowedCallers; /* 10 more */ }Web fetch tool with use_cache parameter for bypassing cached content.
Web fetch tool with use_cache parameter for bypassing cached content.
class WebSearchTool20260318 { type = "web_search_20260318"; name; allowedCallers; /* 8 more */ }
class WebFetchTool20260318 { type = "web_fetch_20260318"; name; allowedCallers; /* 11 more */ }
class ToolSearchToolBm25_20251119 { type; name; allowedCallers; /* 3 more */ }
class ToolSearchToolRegex20251119 { type; name; allowedCallers; /* 3 more */ }
Optional<Double> temperatureDeprecatedAmount 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.
Optional<Long> topKDeprecatedOnly 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.
Optional<Double> topPDeprecatedUse 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
class MessageBatch { type = "message_batch"; id; archivedAt; /* 7 more */ }
package com.anthropic.example;
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.Model;
import com.anthropic.models.messages.batches.BatchCreateParams;
import com.anthropic.models.messages.batches.MessageBatch;
public final class Main {
private Main() {}
public static void main(String[] args) {
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
BatchCreateParams params = BatchCreateParams.builder()
.addRequest(BatchCreateParams.Request.builder()
.customId("my-custom-id-1")
.params(BatchCreateParams.Request.Params.builder()
.maxTokens(1024L)
.addUserMessage("Hello, world")
.model(Model.CLAUDE_OPUS_5_5)
.build())
.build())
.build();
MessageBatch messageBatch = client.messages().batches().create(params);
}
}{
"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"
}