Skip to main content
POST
/
v1
/
renders
Render an asset
curl --request POST \
  --url https://roughy-api-staging.fly.dev/v1/renders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": {
    "frame_rate": 120
  },
  "cut_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cut_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": {
    "frame_rate": 120
  },
  "size_bytes": 123,
  "error_code": "<string>",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

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.