Skip to main content
POST
Localize Voice

Authorizations

x-api-key
string
header
required

API key for authentication. Passed via the x-api-key header.

Body

application/json
src_voice
string
required

The voice to localize: a voice id (your clone, a converted candidate or a flagship voice) or a vox_emb_ candidate id. The source is not modified.

Required string length: 1 - 64
target_language
enum<string>
required

Language the candidates will speak. May equal the source language: that is an accent change.

Available options:
en,
fr,
es,
pt,
de
accent
string | null

One of the accents GET /voice-generator/available-accents lists for target_language, matched case-insensitively. Omitted: the first accent listed for that language.

Maximum string length: 100
gender
enum<string> | null

Opens the edit caption. Omitted: the source voice's gender tag, or the gender of the source candidate's own localization, or no gender. Clones and converted voices carry no tag, so send it for them.

Available options:
male,
female
n_samples
integer
default:1

Number of candidates to produce. All candidates in one request are variations of the same localized speaker.

Required range: 1 <= x <= 5

Response

Candidates accepted, one per requested sample, in request order, all ready: false.

embeddings
GeneratedEmbedding · object[]
required