Skip to main content
POST
render timeline

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 default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json
timeline_id
string
required

The timeline id.

idempotency_key
string
required

Idempotency key (a UUID). A retry with the same key returns the render already dispatched instead of starting a second one; a new render takes a new key.

Required string length: 1 - 200
resolution
enum<string>

Default 1080p. 720p has a short side of 720 if the shape allows. 4k adds detail only where the sources have it and uses more cloud processing. estimate_cost gives an estimate (color and effects on every clip cost several times a plain cut). One export holds about 3 hours at 1080p or 49 minutes at 4k, less with grain; longer is refused with the length it can do.

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

Default mp4. webm keeps the picture's transparency (VP9; no background is drawn), rendered in one pass and metered as a video of its size, so a long timeline is refused with the length it can do; saved as video tagged transparent. mp3 or wav render the sound alone, metered as a 1080p render; saved as audio. gif is silent, about 15 frames a second, at most 720 pixels on the long side and 30 seconds, metered as a 1080p render; saved as an image.

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

Library folder the finished file goes in, by path ("campaigns/july"), name or id. It has to exist already. Left out, it goes to Timeline renders.

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[]