Skip to main content
POST
speakers

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
ref
string
required

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

name
object
unname
integer

Take the name off this speaker in this recording. The workspace still knows the voice.

Required range: x >= 0
merge
object
transcript
boolean

Also return the recording's stored sentences, each labelled with who was speaking.

reread
boolean

Listen again from scratch rather than returning what was read before.

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