Skip to main content
POST
render clips

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the key's own.

Body

application/json
idempotency_key
string
required

One key for the set (a UUID); each clip's render derives its own from it, so the same call retried returns the same jobs.

Required string length: 1 - 200
timeline_id
string

The project whose clips to render. Every clip of it, oldest first.

clips
string[]

The clips to render, by timeline id, in the order you want them started. Give this or timeline_id.

Required array length: 1 - 50 elements
resolution
enum<string>

Default 1080p, as render_timeline.

Available options:
1080p,
4k
format
enum<string>

Default mp4, as render_timeline.

Available options:
mp4,
mp3,
wav,
gif
folder
string

Library folder the finished files land in. It has to exist already.

context
string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]