Skip to main content
POST
extract media

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
ref
string

The image or video item. Give this or timeline_id.

timeline_id
string

A timeline instead of an item: its composite frame at at_time or frame is kept as an image.

mode
enum<string>

crop takes a region of an image. panel takes one cell out of a grid image, the kind a model returns when asked for several options in one picture. frame takes a still out of a video at a moment, and is the mode a timeline_id implies.

Available options:
crop,
panel,
frame
region
object

crop: region as PERCENTAGES (0-100) of the source.

panel_index
integer

panel: 0-based cell index, row-major. Each cell is inset 2% per edge to avoid grid borders, so compose with margin inside the cell.

grid
enum<string>

panel: grid dimensions (default 2x2).

Available options:
2x2,
2x3,
3x3
at_time
number

frame: the moment in seconds, in the video or on the timeline (default 0, the first frame).

Required range: x >= 0
frame
integer

timeline_id: the exact frame number instead of at_time.

Required range: x >= 0
title
string

timeline_id: the item's title. Default: the timeline's name and the timecode.

Maximum string length: 120
folder
string

timeline_id: folder path or id to file it in. Default: unfiled.

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