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

Body

application/json
refs
string[]
required

1 to 20 items.

Required array length: 1 - 20 elements

An item ref, item id, or the job id that made it.

reads
enum<string>[]
required

The reads to start. speakers reads speech too. One that does not apply to an item's type is skipped.

Minimum array length: 1
Available options:
transcript,
search_index,
speech,
speakers,
beats,
levels
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[]