Skip to main content
POST
get transcript

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.

start_frame
integer

The first frame read; next_start_frame from a full page continues it.

end_frame
integer
time_range
tuple

[start, end] in frames, as get_timeline takes it: the same as start_frame and end_frame.

limit
integer

Rows a page holds, at most the page size; the rest continues from next_start_frame.

Required range: 1 <= x <= 10000
granularity
enum<string>

words: every word with its frames, the indices remove_words takes. sentences: a fraction of the size, each row carrying the index of its first word for a cut.

Available options:
words,
sentences
source
enum<string>

Which speech: voiceover (narration), dialogue, music (lyrics); all reads every stream clip by clip with a passages list. Default picks whichever the timeline has.

Available options:
voiceover,
dialogue,
music,
auto,
all
speakers
boolean

Carry who is talking on every row, and the stretches each speaker holds. Read from what the speakers tool found; files nobody has been picked out of are left out rather than listened to now.

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