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 key's own.

Body

application/json
timeline_id
string
required

The timeline id.

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

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