Skip to main content
POST
/
v1
/
batches
/
{batch_id}
/
cancel
Cancel a batch
curl --request POST \
  --url https://api.zerogpu.ai/v1/batches/{batch_id}/cancel \
  --header 'x-api-key: <api-key>' \
  --header 'x-project-id: <api-key>'
{
  "id": "<string>",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "completion_window": "<string>",
  "created_at": 123,
  "expires_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}
Request cancellation while a batch is in_progress or validating. Terminal batches return 409. Poll status on Retrieve batch. Full reference: Batches API.

Authorizations

​
x-api-key
string
header
required
​
x-project-id
string
header
required

Path Parameters

​
batch_id
string
required

Response

Batch cancellation requested

​
id
string
​
object
enum<string>
Available options:
batch
​
endpoint
string
​
status
enum<string>
Available options:
validating,
in_progress,
finalizing,
completed,
failed,
expired,
cancelling,
cancelled
​
input_file_id
string
​
output_file_id
string | null
​
error_file_id
string | null
​
completion_window
string
​
created_at
integer
​
expires_at
integer
​
request_counts
object
​
metadata
object