Skip to main content
POST
inspect timeline

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 default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json
timeline_id
string
required

The timeline id.

frames
integer[]

Exact frame numbers to render.

Maximum array length: 12
seconds
number[]

The same, as timestamps in seconds.

Maximum array length: 12
range
object

count frames spread evenly between start and end, in frames, or start_seconds and end_seconds.

around
integer

A few frames around this frame number.

around_seconds
number

A few frames around this timestamp in seconds.

grid
boolean

False to leave the grid off and return the bare picture. Default true.

span
object

A stretch in seconds, up to 60: one strip of frames, waveform and words instead of separate frames, which is how a cut is judged against the sound. Its frames are drawn and charged like any others.

sheet
boolean

True: the whole timeline as one picture, a grid of evenly spaced frames with their times (about 9 for 30 s, 16 for 3 min), charged as the frames drawn.

tiles
integer

With sheet: how many frames, up to 20. Fewer draws each larger.

Required range: 2 <= x <= 20

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