Skip to main content
GET
Get bulk job status

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

bulkJobId
string
required

Bulk job ID.

Response

Current job state.

bulk_job_id
string
required

Bulk job ID.

status
enum<string>
required

Job state. completed_with_failures means at least one item failed after admission.

Available options:
accepted,
running,
completed,
completed_with_failures,
failed
items
object[]
required

Per-item status, in request order.

template_id
string

Template used for the batch.

auto_publish
boolean

Whether the batch publishes tents automatically.

total
integer

Total submitted items.

queued
integer

Accepted items waiting to generate.

generating
integer

Items currently generating.

completed
integer

Items completed successfully.

failed
integer

Items that failed after admission.

credits
object

Aggregate credit accounting for a bulk job.

created_at
string<date-time>

Job creation time.

updated_at
string<date-time>

Last job update.