Cancel batch - OpenAI API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Authorization

string

required

Example:

Bearer $OPENAI_API_KEY

Content-Type

string

required

Example:

application/json

Body Params multipart/form-data

object {0}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.openai.com/v1/batches/batch_abc123/cancel' \
--header 'Authorization: Bearer $OPENAI_API_KEY'

Responses

🟢200Success

application/json

Body

id

string

required

object

string

required

endpoint

string

required

errors

null

required

input_file_id

string

required

completion_window

string

required

status

string

required

output_file_id

null

required

error_file_id

null

required

created_at

integer

required

in_progress_at

integer

required

expires_at

integer

required

finalizing_at

null

required

completed_at

null

required

failed_at

null

required

expired_at

null

required

cancelling_at

integer

required

cancelled_at

null

required

request_counts

object

required

total

integer

required

completed

integer

required

failed

integer

required

metadata

object

required

customer_id

string

required

batch_description

string

required

Example

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "cancelling",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": 1711475133,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 23,
    "failed": 1
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}