Skip to main content
POST
/
anthropic
/
v1
/
messages
/
batches
/
{batch_id}
/
cancel
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "type": "message_batch",
  "processing_status": "in_progress",
  "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

​
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 to cancel

Response

Successful response

​
id
string
​
type
string
default:message_batch
​
processing_status
enum<string>
Available options:
in_progress,
ended,
canceling
​
request_counts
object
​
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