Skip to main content
POST
/
openai
/
v1
/
batches
/
{batch_id}
/
cancel
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "object": "<string>",
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123,
    "succeeded": 123,
    "expired": 123,
    "canceled": 123,
    "pending": 123
  },
  "cancelling_at": 123,
  "cancelled_at": 123,
  "extra_fields": {
    "request_type": "<string>",
    "model_requested": "<string>",
    "model_deployment": "<string>",
    "latency": 123,
    "chunk_index": 123,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "<string>",
      "hit_type": "<string>",
      "requested_provider": "<string>",
      "requested_model": "<string>",
      "provider_used": "<string>",
      "model_used": "<string>",
      "input_tokens": 123,
      "threshold": 123,
      "similarity": 123
    }
  }
}

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.

Path Parameters

​
batch_id
string
required

Batch job ID to cancel

Query Parameters

​
provider
string

Provider for the batch

Response

Successful response

​
id
string
​
object
string
​
status
enum<string>
Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
canceled,
ended
​
request_counts
object
​
cancelling_at
integer<int64>
​
cancelled_at
integer<int64>
​
extra_fields
object

Additional fields included in responses