列出訊息批次

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.

Query Parameters

before_id

string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

after_id

string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

limit

integer

default: 20

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

Required range: 1 < x < 1000

Response

200 - application/json

data

object[]

required

data.id

string

required

Unique object identifier.

The format and length of IDs may change over time.

data.type

enum<string>

default: message_batchrequired

Object type.

For Message Batches, this is always "message_batch".

Available options:

message_batch

data.processing_status

enum<string>

required

Processing status of the Message Batch.

Available options:

in_progress,

canceling,

ended

data.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.

data.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.

data.created_at

string

required

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

data.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.

data.archived_at

string | null

required

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

data.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.

data.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.

has_more

boolean

required

Indicates if there are more results in the requested page direction.

first_id

string | null

required

First ID in the data list. Can be used as the before_id for the previous page.

last_id

string | null

required

Last ID in the data list. Can be used as the after_id for the next page.

使用 API

Vertex AI

Amazon Bedrock API

Anthropic API

列出訊息批次

Headers

Query Parameters

Response