Skip to main content
POST
Error

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