Skip to main content
POST
auto reframe

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 reframe. Absent: every video clip on the timeline.

view
object

Show one area of the source for the whole clip: its centre as fractions of the source (x 0 left, y 0 top) and, to zoom, its width as a fraction of the source width; no width shows as much as the box holds. Kept inside the picture, up to 5x. Needs clip_id (video or image). Replaces the clip's scale, pan and focus track.

subject
enum<string>

What the crop follows: people (default; a person's head is what it aims at), or any subject, the largest thing detected when no person is in shot.

Available options:
person,
any
follow
enum<string>

Where two people share the frame: speaker cuts the crop to whoever is talking, from a speaking-face read at a dozen of each voice's turns, once per recording. Needs speakers on the recording; where it cannot tell, the crop stays centred and says so. Default holds both.

Available options:
subject,
speaker
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[]