메시지 배치 검색 (베타)
This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the results_url
field in the response.
anthropic-beta
헤더에 message-batches-2024-09-24
값을 전달해야 합니다Headers
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.
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.
Path Parameters
ID of the Message Batch.
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 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.
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.