Render

Get render job status

Retrieve the status, progress, and result of a render job by ID.

get/api/jobs/{id}

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/jobs/{id}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required
Example:550e8400-e29b-41d4-a716-446655440000

Render job ID

Response

Render job found

idstring required

Job identifier

statestring nullable required

Queue states include waiting, prioritized, active, delayed, completed and failed. Treat completed/failed as terminal; keep polling other states with bounded backoff.

failedReasonstring nullable

Failure reason if the job failed

outputExpiresAtstring date-time nullable

Availability deadline based on the plan recorded for this render, starting at completion. URLs are withheld after this time.

outputExpiredAtstring date-time nullable

When expiration cleanup was recorded. Check outputExpiresAt even while cleanup is pending.

outputCleanupStatusstring nullable

Output cleanup progress; failed storage deletion or cache purges are retried.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "failedReason": "Render timeout"
}

Changes

No recorded changes to this operation across all 1 revision of this API.