Skip to main content
POST
edit 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
clips
string[]
required

The clips to change, by timeline id.

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

The shape every one of them takes.

Available options:
16:9,
9:16,
21:9,
9:21,
1:1,
4:3,
3:4,
3:2,
2:3,
5:4,
4:5
captions

A caption look every clip wears (a template saved for the workspace, or a built-in one), or false to take the captions off.

emphasis
object

The words this set is about, lit and marked.

zoom

Punch in on the words, as auto_zoom does, or false to take the punches off.

Available options:
light,
medium,
strong
reframe

Move each crop to follow the subject; "speaker" follows whoever is talking where two people share the frame, on a recording the voices have been told apart in (speakers).

platforms
string[]

Where these cuts are meant to go, as cut_clips names them. Drawn as marks under each tile; the shape does not change, give aspect for that.

Maximum array length: 6
hook_style
object

A new look for every hook in these clips; only the fields given change: font_family, font_size (px at the clip's resolution), font_weight (100 to 900), color, background_color (null for none), background_opacity, background_padding, background_radius, position (top-left to bottom-right), offset_y, text_transform (none|uppercase|lowercase|capitalize), animation (none|fade|slide|pop), stroke_color, stroke_width, seconds (0.5 to 15).

bleep

Bleep swearing: the sound covered where it is said and the word starred in the captions. true takes the usual list.

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