Skip to main content
POST
/
v1
/
batches
/
{batch_id}
/
cancel
Cancel Batch
curl --request POST \
  --url http://localhost:8080/v1/batches/{batch_id}/cancel \
  --header 'x-model-provider: <x-model-provider>'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "cancelling_at": 123,
  "cancelled_at": 123,
  "extra_fields": "<unknown>"
}

Headers

x-model-provider
string
required

The model provider

Path Parameters

batch_id
string
required

The ID of the batch to cancel

Response

200 - application/json

Batch cancelled

id
string
object
string
status
string
cancelling_at
integer
cancelled_at
integer
extra_fields
any