Manage cancel Batch.

Contract-preserving POST Endpoint for cancel Batch in the OpenAI API. Model and resource-specific values are supplied by the caller at runtime.

All 288 OpenAI Platform REST endpoints from a fixed MIT-licensed official revision, including typed SSE streaming and Realtime call management. Hub provides documentation and an independent SDK/CLI, but never proxies model, account, or usage data; callers connect directly with local API keys.

Request

operationId: cancelBatch
Server: https://api.openai.com/v1
Authentication: ApiKeyAuth, AdminApiKeyAuth

Request parameters

`batch_id`

pathstringrequired

batch id value in the OpenAI API contract.

Responses

`200`

Batchapplication/json

Successful supplier response.

Properties: cancelled_atcancelling_atcompleted_atcompletion_windowcreated_atendpointerror_file_iderrorsexpired_atexpires_atfailed_atfinalizing_atidin_progress_atinput_file_idmetadatamodelobjectoutput_file_idrequest_countsstatususage

{
  "cancelled_at": 0,
  "cancelling_at": 0,
  "completed_at": 0,
  "created_at": 0,
  "errors": {
    "data": {}
  }
}