POST
/
batches
/
{batch_id}
/
cancel
curl --request POST \
  --url https://api.openai.com/v1/batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "batch",
  "endpoint": "<string>",
  "errors": {
    "object": "<string>",
    "data": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>",
        "line": 123
      }
    ]
  },
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batch_id
string
required

The ID of the batch to cancel.

Response

200 - application/json

Batch is cancelling. Returns the cancelling batch's details.

The response is of type object.