Skip to main content
POST
cut 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
timeline_id
string
required

The project the clips land in: any timeline, empty or not, or a clip already in it. The recording itself is ref.

ref
string
required

The recording being cut, as a library ref.

clips
object[]
required

The moments, in the order they should be numbered. Up to 50 a call.

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

The shape every clip is cut at, 9:16 for shorts. Absent leaves each clip at the project's.

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
string

Caption every clip in this look: a template saved for the workspace, or a built-in one: Subtitles, Kinetic, One word, Karaoke, Broadcast, Boxed, Story, Social, Hook. Absent leaves the clips uncaptioned.

hook_style
object

How every hook in the set looks; absent, a white box with dark bold type near the top for three seconds: 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).

emphasis
object

The words this set is about, lit and marked.

bleep

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

zoom
enum<string>

Punch in on the words, as auto_zoom does. Absent leaves the framing still.

Available options:
light,
medium,
strong
reframe

Move each clip's crop to follow the subject, for a cut whose shape differs from the recording's. speaker follows whoever is talking where two people share the frame (needs speakers on the recording).

layout
object

For a stream or tutorial with a face-cam: the camera in one band and the screen in the other, each cropped to its region, on tall and square clips. Regions come off a frame (inspect_media). Replaces reframe and zoom.

allow_duplicates
boolean

Cut a span the project already holds a clip of. Off, such a span is skipped and the clip it already is named in skipped, so a retried call cannot double the set.

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