Skip to main content
POST
auto zoom

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
timeline_id
string
required

The timeline id.

clip_id
string

The video clip to punch. Absent: every video clip that carries words.

intensity
enum<string>

How often and how close: light about one punch per 8s at 112%, medium per 5s cycling 115% and 130% (default), strong per 3s up to 145%.

Available options:
light,
medium,
strong
moments_seconds
number[]

Clip-relative seconds to punch on instead of reading the words: beats, key lines. Spacing and edge rules still apply.

beats_of
string

A music clip on this timeline: punch on its stored beats (detect_beats), mapped through its trim, speed and placement onto every target clip. Spacing and edge rules still apply.

if_revision

The revision get_timeline returned. A stale one fails with revision_conflict instead of applying; so does no revision once a user edited the timeline in the app since this connection last read it.

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