Retrieve batch job (Anthropic format)

Retrieves details of a batch processing job.

GET /anthropic/v1/messages/batches/{batch_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "type": "message_batch",
  "request_counts": {
    "processing": 123,
    "succeeded": 123,
    "errored": 123,
    "canceled": 123,
    "expired": 123
  },
  "ended_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "cancel_initiated_at": "2023-11-07T05:31:56Z",
  "results_url": "<string>"
}

Authorizations

BearerAuthBasicAuthVirtualKeyAuthApiKeyAuth

Authorization · string · header · required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Headers

x-model-provider · string

Provider for the batch

Path Parameters

batch_id · string · required

Batch job ID

Response

200

application/json

Successful response

id · string

type · string · default: message_batch

processing_status · enum<string>

Available options: in_progress, ended, canceling

request_counts · object

Show child attributes

ended_at · string<date-time> | null

created_at · string<date-time>

expires_at · string<date-time>

archived_at · string<date-time> | null

cancel_initiated_at · string<date-time> | null

results_url · string | null