Skip to main content
POST
Render an asset

Authorizations

Authorization
string
header
required

Pass your API key as Authorization: Bearer sk_…. Mint a key from your dashboard's API-keys page.

Body

application/json

Render to produce for an asset.

asset_id
string<uuid>
required

The asset to render.

output
RenderOutput · object
required

The desired output spec.

cut_id
string<uuid> | null

The cut to apply (it must belong to this asset and be completed). Omit to render the full source.

Response

A render with the same inputs already exists; it is returned.

A render.

id
string<uuid>
required

Render id.

asset_id
string<uuid>
required

The source asset this render was produced from.

cut_id
string<uuid> | null
required

The cut applied to this render, or null for a full-source render.

state
enum<string>
required

Render lifecycle state: pending / processing while the render encodes, completed when ready, failed on error. completed and failed are terminal.

Available options:
pending,
processing,
completed,
failed
output
RenderOutput · object
required

The output spec this render was produced with.

size_bytes
integer | null
required

Output size in bytes.

error_code
string | null
required

Machine-readable failure code when state=failed.

error_message
string | null
required

Human-readable failure detail when state=failed.

created_at
string<date-time>
required

When the render was created.

started_at
string<date-time> | null
required

When encoding started.

completed_at
string<date-time> | null
required

When the render reached a terminal state.