Skip to main content
GET
/
v1
/
batches
/
{batch_id}
Retrieve a batch
curl --request GET \
  --url https://api.zerogpu.ai/v1/batches/{batch_id} \
  --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": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.zerogpu.ai/llms.txt

Use this file to discover all available pages before exploring further.

Poll a batch by ID. Use this while status is in_progress or cancelling; stop when the status is terminal (completed, failed, expired, or cancelled). When complete, download results with output_file_id and error_file_id via Files API.

Authorizations

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

Path Parameters

​
batch_id
string
required

Response

Batch object

​
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