Skip to main content
POST
check 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

The timeline id; a project's id checks every timeline in it.

timeline_ids
string[]

Timelines to check in one call, in place of timeline_id; 25 a call.

Required array length: 1 - 100 elements
cursor
string

next_cursor from an earlier call: checks the timelines after it. With next_cursor, timelines remain unchecked and ok is false.

audio
boolean

Measure the sound too. Default true; false checks the structure alone.

platform
enum<string>

Where it plays, which sets the loudness the speech is read against: youtube, instagram and tiktok -14 LUFS, podcast -16, broadcast -23. Default youtube.

Available options:
youtube,
instagram,
tiktok,
podcast,
broadcast
frames

One timeline only. A storyboard in one picture: this many frames spread evenly, or "clips" for one at the middle of each clip and title card (up to 20; storyboard.not_drawn_clips names the rest).

Required range: 1 <= x <= 12

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