Create a Message Batch (Beta)
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.
anthropic-beta header with value message-batches-2024-09-24Feature Support
The Message Batches API supports the following models: Claude 3 Haiku, Claude 3 Opus, and Claude 3.5 Sonnet. All features available in the Messages API, including beta features, are available through the Message Batches API.
While in Beta, batches may contain up to 10,000 requests and be up to 32 MB in total size.
Headers
Optional header to specify the beta version(s) you want to use.
If passing in multiple, use a comma separated list, e.g. beta1,beta2.
The version of the Anthropic API you want to use.
Read more about versioning and our version history here.
Your unique API key for authentication.
This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the Console. Each key is scoped to a Workspace.
Body
List of requests for prompt completion. Each is an individual request to create a Message.
Response
Unique object identifier.
The format and length of IDs may change over time.
Object type.
For Message Batches, this is always "message_batch".
message_batch Processing status of the Message Batch.
in_progress, canceling, ended 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.
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 was created.
RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
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.