Skip to main content
POST
change language

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.

target_language
enum<string>
required

The language to speak. The values here are the whole supported set.

Available options:
en,
es,
fr,
de,
it,
pt,
ja,
ko,
zh,
ar,
hi,
ru,
nl,
pl,
sv,
da,
fi,
no,
cs,
sk,
hu,
ro,
bg,
hr,
uk,
el,
tr,
th,
vi,
id,
ms,
fil,
ta,
te,
ml,
kn,
bn,
gu,
mr,
pa,
he,
fa,
ur,
sw,
ha,
af,
ga,
cy,
is,
ca,
gl,
sl,
et,
lv,
lt,
sr,
bs,
mk,
ka,
hy,
az,
kk,
ne
idempotency_key
string
required

A key you mint per dispatch (a UUID). The same key on a retry returns the job already dispatched instead of charging again; a new attempt takes a new key.

Required string length: 1 - 200
as_new_timeline
boolean

Default true: a forked copy named " · ". False writes over this timeline.

True confirms, on the user's behalf: "I have the right to clone this voice: it is my own, or the person speaking has agreed to it being recreated and used in this project." Speakers with no voice then get one built from their recording. Omitted, they are left as they are.

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