Skip to main content
GET
Get batch details

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 unique identifier of the batch.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Batch found and returned successfully.

Response containing batch details with all tasks.

completed
boolean
required

Whether all tasks in the batch have finished.

completed_count
number
required

Number of tasks that have completed so far.

created_at
string
required

ISO timestamp when the batch was created.

id
string
required

Unique identifier for the batch.

progress
number
required

Completion ratio between 0 and 1.

status
string
required
Allowed value: "success"
tasks
(object | null)[]
required

List of tasks in the batch.

completed_at
string

ISO timestamp when the batch completed.