POST
/
v1
/
messages
/
batches
/
{message_batch_id}
/
cancel

Headers

​
anthropic-beta
string[]

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

​
anthropic-version
string
required

The version of the Anthropic API you want to use.

Read more about versioning and our version history here.

​
x-api-key
string
required

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.

Path Parameters

​
message_batch_id
string
required

ID of the Message Batch.

Response

200 - application/json
​
id
string
required

Unique object identifier.

The format and length of IDs may change over time.

​
type
enum<string>
default: message_batchrequired

Object type.

For Message Batches, this is always "message_batch".

Available options:
message_batch
​
processing_status
enum<string>
required

Processing status of the Message Batch.

Available options:
in_progress,
canceling,
ended
​
request_counts
object
required

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.

​
ended_at
string | null
required

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.

​
created_at
string
required

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

​
expires_at
string
required

RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.

​
archived_at
string | null
required

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

​
cancel_initiated_at
string | null
required

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

​
results_url
string | null
required

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.

Was this page helpful?

Список пакетов сообщенийПримеры пакетной обработки сообщений