Skip to main content
GET
Get a render job

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer kdsc_live_<...>. Generate keys from the developer dashboard. Keys are returned in plaintext only once at creation time — store them like a password.

Path Parameters

jobId
string
required

The jobId returned from POST /api/v2/render.

Response

Job state.

jobId
string
required
endpoint
enum<string>
required
Available options:
render
status
enum<string>
required

Lifecycle state of the job. completed and failed are terminal.

Available options:
queued,
running,
completed,
failed
creditsCost
number
required

Credits the job has consumed so far. 0 until the job completes.

durationMs
integer | null
required

Render wall-clock time in milliseconds. null until the job reaches a terminal state.

result
object | null
required

Result payload, populated only when status is completed.

error
string | null
required

Human-readable error message, populated only when status is failed.

metadata
any
required

Whatever you passed in the request body's metadata field, echoed back unchanged.

createdAt
string<date-time>
required

ISO 8601 timestamp when the job was enqueued.

completedAt
string<date-time> | null
required

ISO 8601 timestamp when the job reached a terminal state, or null while still running.