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.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Gradium API","description":"Developer documentation for Gradium's low-latency Text-to-Speech and Speech-to-Text APIs, including SDK guides, WebSocket streaming, REST endpoints, voices, and pronunciation tools.","colors":{"primary":"#6EC1B4","light":"#4A9E8E","dark":"#7CD4C6"},"logo":{"light":"https://mintcdn.com/gradium/GDCr2JwQuyR9FBIc/logo/light.svg?fit=max\u0026auto=format\u0026n=GDCr2JwQuyR9FBIc\u0026q=85\u0026s=4e223cfbc61a80de5f42cc8bfff10508","dark":"https://mintcdn.com/gradium/GDCr2JwQuyR9FBIc/logo/dark.svg?fit=max\u0026auto=format\u0026n=GDCr2JwQuyR9FBIc\u0026q=85\u0026s=47406cf6d0215c3060aa224372c39004","href":"https://gradium.ai"},"favicon":"https://mintcdn.com/gradium/GDCr2JwQuyR9FBIc/favicon.svg?fit=max\u0026auto=format\u0026n=GDCr2JwQuyR9FBIc\u0026q=85\u0026s=9b17a838bdcef7e59e0ef9c7b3477b7a","appearance":{"default":"dark"},"background":{"color":{"light":"#f9fafb","dark":"#111111"}},"navbar":{"links":[{"href":"mailto:support@gradium.ai","label":"Support"}]},"footer":{"socials":{"discord":"https://discord.com/invite/bcysuPRzXE"},"links":[{"header":"Security","items":[{"label":"Security and compliance","href":"/guides/security"},{"label":"Trust Center","href":"https://trust.gradium.ai/"}]}]},"seo":{"metatags":{"google-site-verification":"JGCXmoglT2vtrleIoN0s9t3qUR2C5h5Qs66nKc4q8v0","og:image":"https://docs.gradium.ai/og-image.png","twitter:image":"https://docs.gradium.ai/og-image.png","twitter:site":"@GradiumAI","twitter:card":"summary_large_image"},"indexing":"all"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@gradium.ai"}]},"languages":[{"language":"en","href":""},{"language":"fr","footer":{"socials":{"discord":"https://discord.com/invite/bcysuPRzXE"},"links":[{"header":"Sécurité","items":[{"label":"Sécurité et conformité","href":"/fr/guides/security"},{"label":"Trust Center","href":"https://trust.gradium.ai/"}]}]},"navbar":{"links":[{"href":"mailto:support@gradium.ai","label":"Support"}]},"href":"fr"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gradium","hasAudioNarration":false,"actualSubdomain":"gradium","customDomains":["docs.gradium.ai"],"gitSource":{"type":"github","owner":"gradium-ai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b002b452d0cf2e9fca11a82","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"en","tag":"Guides","count":49},{"language":"fr","tag":"Guides","count":48},{"language":"en","tag":"API Reference","count":24},{"language":"fr","tag":"Référence API","count":24},{"language":"en","tag":"Voices","count":12},{"language":"fr","tag":"Voix","count":12},{"language":"en","tag":"Integrations","count":10},{"language":"fr","tag":"Intégrations","count":10},{"language":"en","tag":"Resources","count":8},{"language":"en","tag":"Release Notes","count":7},{"language":"en","tag":"2026","count":7},{"language":"fr","tag":"Ressources","count":7},{"language":"fr","tag":"Notes de version","count":7},{"language":"fr","tag":"2026","count":7},{"language":"en","tag":"Speech-to-Text","count":6},{"language":"en","tag":"Text-to-Speech","count":6},{"language":"fr","tag":"Transcription (STT)","count":6},{"language":"fr","tag":"Synthèse vocale (TTS)","count":6},{"language":"en","tag":"Pronunciations","count":5},{"language":"fr","tag":"Prononciations","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"pre button,pre [class*=\"copy\"],div[class*=\"codeblock\"] button,div[class*=\"code-block\"] button{background:transparent!important;border:none!important;box-shadow:none!important}div[class*=\"codeblock\"],div[class*=\"code-block\"]{border:none!important;box-shadow:none!important}html:not(.dark) :not(pre)>code{background-color:#e8f4f1!important}html:not(.dark) pre{background-color:#eef7f5!important;border:none!important}html:not(.dark) pre code{color:#1f2328!important}html:not(.dark) pre .token.keyword,html:not(.dark) pre .token.operator,html:not(.dark) pre .token.interpolation-punctuation{color:#cf222e!important}html:not(.dark) pre .token.string,html:not(.dark) pre .token.attr-value{color:#0a3069!important}html:not(.dark) pre .token.function,html:not(.dark) pre .token.class-name{color:#8250df!important}html:not(.dark) pre .token.property{color:#0550ae!important}html:not(.dark) pre .token.boolean,html:not(.dark) pre .token.number,html:not(.dark) pre .token.constant{color:#0550ae!important}html:not(.dark) pre .token.builtin{color:#953800!important}html:not(.dark) pre .token.comment{color:#6e7781!important;font-style:italic}html:not(.dark) pre .token.punctuation{color:#1f2328!important}html:not(.dark) pre .token.tag{color:#116329!important}html:not(.dark) pre .token.attr-name{color:#0550ae!important}html.dark pre{background-color:#161b22!important;border:none!important}html.dark pre code{color:#e6edf3!important}html.dark pre .token.keyword,html.dark pre .token.operator,html.dark pre .token.interpolation-punctuation{color:#ff7b72!important}html.dark pre .token.string,html.dark pre .token.attr-value{color:#a5d6ff!important}html.dark pre .token.function,html.dark pre .token.class-name{color:#d2a8ff!important}html.dark pre .token.property{color:#79c0ff!important}html.dark pre .token.boolean,html.dark pre .token.number,html.dark pre .token.constant{color:#79c0ff!important}html.dark pre .token.builtin{color:#ffa657!important}html.dark pre .token.comment{color:#8b949e!important;font-style:italic}html.dark pre .token.punctuation{color:#e6edf3!important}html.dark pre .token.tag{color:#7ee787!important}html.dark pre .token.attr-name{color:#79c0ff!important}.voice-table-wrapper{width:100%;overflow-x:auto}.voice-table{width:100%;border-collapse:collapse;font-size:14px}.voice-table th{text-align:left;padding:8px 10px;font-weight:600;font-size:12px;text-transform:uppercase;letter-spacing:0.03em;white-space:nowrap;border-bottom:2px solid rgba(110, 193, 180, 0.3)}.voice-table td{padding:8px 10px;border-bottom:1px solid rgba(128, 128, 128, 0.15);vertical-align:top;line-height:1.4}.voice-table tbody tr:hover{background:rgba(110, 193, 180, 0.06)}.voice-name{font-weight:600;white-space:nowrap}.voice-desc{font-size:0.9em}html.dark{--voice-id-cyan: #91fffa}html:not(.dark){--voice-id-cyan: #0a7a76}.voice-id-row{display:inline-flex;align-items:center;gap:4px;margin-top:3px;margin-left:-5px;padding:1px 5px;border-radius:6px;white-space:nowrap;transition:background 0.15s}.voice-table tbody tr:hover .voice-id-row{background:rgba(110, 193, 180, 0.12)}.voice-id-copy,.voice-id-play{display:inline-flex;align-items:center;gap:5px;padding:0;border:none;background:transparent;color:var(--voice-id-cyan);cursor:pointer}.voice-id-copy code{font-size:0.78em;background:transparent;padding:0;color:inherit}.voice-id-play{text-decoration:none!important;border-bottom:none!important}.voice-id-icon{opacity:0;flex-shrink:0;transition:opacity 0.15s}.voice-table tbody tr:hover .voice-id-icon{opacity:0.65}.voice-id-copy:hover .voice-id-icon,.voice-id-copy:focus-visible .voice-id-icon,.voice-id-play:hover .voice-id-icon,.voice-id-play:focus-visible .voice-id-icon,.voice-id-copy.is-copied .voice-id-icon{opacity:1}@media (hover: none){.voice-id-icon{opacity:0.75}}.flagship-voices{--flagship-line: #e5e7eb;--flagship-surface: #f9fafb;--flagship-hover: rgb(75 85 99 / 5%);--flagship-text: #374151;--flagship-muted: rgb(3 7 18 / 50%);--flagship-accent: #4A9E8E}html.dark .flagship-voices{--flagship-line: rgb(255 255 255 / 7%);--flagship-surface: #111111;--flagship-hover: rgb(229 231 235 / 5%);--flagship-text: #d1d5db;--flagship-muted: rgb(255 255 255 / 50%);--flagship-accent: #7CD4C6}.flagship-filters{display:flex;flex-wrap:wrap;justify-content:flex-end;gap:8px;margin:0 0 4px}.flagship-dropdown{position:relative}.flagship-trigger{display:inline-flex;align-items:center;gap:6px;padding:6px 10px 6px 12px;border:1px solid var(--flagship-line);border-radius:12px;background:var(--flagship-surface);color:var(--flagship-text);font-size:14px;line-height:20px;cursor:pointer;transition:background 0.15s}.flagship-trigger:hover,.flagship-trigger.is-open{background:var(--flagship-hover)}.flagship-trigger:focus-visible,.flagship-option:focus-visible{outline:2px solid var(--flagship-accent);outline-offset:-2px}.flagship-trigger-label{color:var(--flagship-muted)}.flagship-trigger-value{font-weight:500}.flagship-chevron{color:var(--flagship-muted);transition:transform 0.15s}.flagship-trigger.is-open .flagship-chevron{transform:rotate(180deg)}.flagship-menu{position:absolute;top:calc(100% + 6px);right:0;z-index:30;min-width:100%;max-height:380px;overflow-y:auto;margin:0!important;padding:4px!important;list-style:none!important;border:1px solid var(--flagship-line);border-radius:16px;background:var(--flagship-surface);box-shadow:0 20px 25px -5px rgb(107 114 128 / 5%), 0 8px 10px -6px rgb(107 114 128 / 5%)}html.dark .flagship-menu{box-shadow:none}.flagship-voices ul.flagship-menu>li{display:block;margin:0!important;padding:0!important;padding-inline-start:0!important}.flagship-voices ul.flagship-menu>li::before,.flagship-voices ul.flagship-menu>li::marker{content:none!important}.flagship-option{display:flex;align-items:center;justify-content:space-between;gap:16px;width:100%;padding:6px 10px;border:none;border-radius:12px;background:transparent;color:var(--flagship-muted);font-size:14px;line-height:20px;text-align:left;white-space:nowrap;cursor:pointer}.flagship-option:hover{background:var(--flagship-hover);color:var(--flagship-text)}.flagship-option.is-selected{color:var(--flagship-text);font-weight:500}.flagship-option svg{flex-shrink:0;color:var(--flagship-accent)}.flagship-note{margin:4px 0 10px!important;font-size:13px;line-height:1.5;color:var(--flagship-muted)}.flagship-empty{margin:0 0 4px!important;font-size:14px;color:var(--flagship-muted)}.flagship-voices .voice-table tr.flagship-gender-break td{border-top:2px solid rgba(110, 193, 180, 0.3)}.flagship-nowrap{white-space:nowrap}.flagship-voices .voice-table td{vertical-align:middle}.flagship-voice-cell{display:flex;align-items:center;gap:10px}.flagship-voice-text{min-width:0}.flagship-listen{display:inline-flex;align-items:center;justify-content:center;flex-shrink:0;width:30px;height:30px;padding:0 0 0 2px;border:1px solid var(--flagship-line);border-radius:50%;background:transparent;color:var(--flagship-muted);cursor:pointer;transition:border-color 0.15s, color 0.15s, background 0.15s}html.dark .flagship-voices .flagship-listen{border-color:rgb(255 255 255 / 14%)}.flagship-listen:hover,.flagship-listen:focus-visible{border-color:var(--flagship-accent)!important;color:var(--flagship-accent)}.flagship-listen.is-playing{padding-left:0;border-color:var(--flagship-accent)!important;background:color-mix(in srgb, var(--flagship-accent) 15%, transparent);color:var(--flagship-accent)}#content-area:has(.update){max-width:48rem}.certification-card{display:flex;align-items:center;gap:1.5rem;margin:2rem 0;padding:1.5rem;border:1px solid rgb(128 128 128 / 25%);border-radius:1rem}.certification-badge{flex:0 0 160px}.certification-badge img{display:block;width:160px;height:auto;margin:0}.certification-badge img.soc-2-badge{width:auto;height:120px;margin:0 auto}.certification-details h2{margin:0 0 0.75rem;font-size:1.125rem;font-weight:600;line-height:1.4}.certification-details p{margin:0 0 1rem;line-height:1.65}.certification-details a{font-weight:600;text-decoration:underline;text-underline-offset:4px}@media (max-width: 640px){.certification-card{flex-direction:column;align-items:flex-start;gap:1rem}.certification-badge{flex-basis:auto;align-self:center}}"}]}
{"page":{"pagePath":"api-reference/endpoint/localize-voice","slug":"/api-reference/endpoint/localize-voice","pageMetadata":{"title":"Localize Voice","openapi":"POST /voice-generator/localize","description":"Adapt an existing voice to another language or accent.","href":"/api-reference/endpoint/localize-voice"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Adapt an existing voice to another language or accent.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Localize Voice","openapi":"POST /voice-generator/localize","description":"Adapt an existing voice to another language or accent.","href":"/api-reference/endpoint/localize-voice"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/gradium/6237bef2decf40f6/reo.js"],"openApiReferenceData":{"operation":{"tags":["Voice Localization"],"summary":"Localize Voice","operationId":"localize_voice_voice_generator_localize_post","description":"Adapt an existing voice to another language or accent.","requestBody":"c2cba400-6342-4ead-9eed-1ff70ed0a842","responses":{"201":"ff6a1b99-05fb-48d9-8573-d231a39868bc","404":"e90fa939-feaa-4bdc-bee8-eb05b7e2f51b","409":"a1a95c8c-db17-4d4f-9a99-26a73816e963","422":"e05e3f77-4784-4172-a727-7a95b0f3cbdd","503":"36ad4a7e-77fe-45f2-851d-03427af508ce"},"method":"post","type":"path","servers":["e7bf0a8e-d9c8-4dd0-9171-8e96208451ad"],"security":["f8a5bb70-2180-4ec6-92c2-552d125b6506"],"path":"/voice-generator/localize","baseUrlOptions":["https://api.gradium.ai/api"],"title":"Localize Voice","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["src_voice","target_language"],"title":"LocalizeRequest","properties":{"src_voice":{"type":"string","minLength":1,"maxLength":64,"title":"Src Voice","description":"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.","isRequired":true,"uniqueKey":"src_voice","typeLabel":"string"},"target_language":{"type":"string","enum":["en","fr","es","pt","de"],"title":"Target Language","description":"Language the candidates will speak. May equal the source language: that is an accent change.","isRequired":true,"uniqueKey":"target_language","typeLabel":"enum\u003cstring>"},"accent":{"oneOf":[{"type":"string","title":"Accent","description":"One of the accents `GET /voice-generator/available-accents` lists for `target_language`, matched case-insensitively. Omitted: the first accent listed for that language.","maxLength":100,"uniqueKey":"accent.oneOf.0","typeLabel":"string"},{"type":"null","title":"Accent","description":"One of the accents `GET /voice-generator/available-accents` lists for `target_language`, matched case-insensitively. Omitted: the first accent listed for that language.","uniqueKey":"accent.oneOf.1","typeLabel":"null"}],"uniqueKey":"accent","typeLabel":"string | null"},"gender":{"oneOf":[{"type":"string","title":"Gender","description":"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.","enum":["male","female"],"uniqueKey":"gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Gender","description":"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.","uniqueKey":"gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"gender","typeLabel":"enum\u003cstring> | null"},"n_samples":{"type":"integer","minimum":1,"maximum":5,"default":1,"title":"N Samples","description":"Number of candidates to produce. All candidates in one request are variations of the same localized speaker.","uniqueKey":"n_samples","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"LocalizeRequest · object"},"examples":{"Example":{"title":"Example","value":{"src_voice":"\u003cstring>","accent":"\u003cstring>","n_samples":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ff6a1b99-05fb-48d9-8573-d231a39868bc":{"description":"Candidates accepted, one per requested sample, in request order, all `ready: false`.","content":{"application/json":{"schema":{"properties":{"embeddings":{"type":"array","items":{"properties":{"embedding_id":{"type":"string","title":"Embedding Id","description":"Candidate id, prefixed `vox_emb_`. Pass it as `voice_id` to audition the candidate.","isRequired":true,"uniqueKey":"embeddings.items.[INDEX].embedding_id","typeLabel":"string"},"ready":{"type":"boolean","title":"Ready","description":"Whether the candidate has finished generating. Newly created candidates start as `false`.","isRequired":true,"uniqueKey":"embeddings.items.[INDEX].ready","typeLabel":"boolean"},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"UTC time the candidate is removed, 30 days after creation. Cleared once you keep the candidate.","isRequired":true,"uniqueKey":"embeddings.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["embedding_id","ready","expires_at"],"title":"GeneratedEmbedding","uniqueKey":"embeddings.items.[INDEX]","typeLabel":"GeneratedEmbedding · object"},"title":"Embeddings","isRequired":true,"uniqueKey":"embeddings","typeLabel":"GeneratedEmbedding · object[]"}},"type":"object","required":["embeddings"],"title":"VoiceGenerationResponse","uniqueKey":"","typeLabel":"VoiceGenerationResponse · object"},"examples":{"Example":{"title":"Example","value":{"embeddings":[{"embedding_id":"\u003cstring>","ready":true,"expires_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e90fa939-feaa-4bdc-bee8-eb05b7e2f51b":{"description":"Unknown source, or a voice or candidate belonging to another account.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a1a95c8c-db17-4d4f-9a99-26a73816e963":{"description":"Source cannot be localized: no language set, candidate not ready, pro clone, or unsupported source language. `detail` says which.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e05e3f77-4784-4172-a727-7a95b0f3cbdd":{"description":"Validation Error: invalid `target_language`, `accent` (the message lists the valid accents), `gender` or `n_samples`.","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"36ad4a7e-77fe-45f2-851d-03427af508ce":{"description":"The source audio could not be copied or no voice generator is available. Nothing was created; retry.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"f8a5bb70-2180-4ec6-92c2-552d125b6506":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Passed via the `x-api-key` header.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"e7bf0a8e-d9c8-4dd0-9171-8e96208451ad":{"url":"https://api.gradium.ai/api","description":"Gradium API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Passed via the `x-api-key` header.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Passed via the `x-api-key` header.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"gradium","siteName":"Gradium API","title":"Localize Voice - Gradium API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoint/localize-voice","matchLevel":0},"fr":{"href":"/fr/api-reference/endpoint/localize-voice","matchLevel":1}}},"lastModified":"2026-10-08T08:51:31.852Z","originalFileLocation":"api-reference/endpoint/localize-voice.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Adapt an existing voice to another language or accent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gradium API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Localize Voice - Gradium API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adapt an existing voice to another language or accent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gradium API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.gradium.ai/og-image.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Localize Voice - Gradium API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adapt an existing voice to another language or accent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.gradium.ai/og-image.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gradium/2pJpQxX9osISU_fN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gradium API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6EC1B4\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"JGCXmoglT2vtrleIoN0s9t3qUR2C5h5Qs66nKc4q8v0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/localize-voice.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.gradium.ai/fr/api-reference/endpoint/localize-voice\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gradium.ai/#organization\",\"name\":\"Gradium API\",\"url\":\"https://docs.gradium.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gradium/GDCr2JwQuyR9FBIc/logo/light.svg?fit=max\u0026auto=format\u0026n=GDCr2JwQuyR9FBIc\u0026q=85\u0026s=4e223cfbc61a80de5f42cc8bfff10508\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gradium.ai#website\",\"name\":\"Gradium API\",\"url\":\"https://docs.gradium.ai\",\"publisher\":{\"@id\":\"https://docs.gradium.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice#webpage\",\"url\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\",\"name\":\"Localize Voice\",\"description\":\"Adapt an existing voice to another language or accent.\",\"dateModified\":\"2026-10-08T08:51:31.852Z\",\"isPartOf\":{\"@id\":\"https://docs.gradium.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Voice Localization\",\"item\":\"https://docs.gradium.ai/api-reference/endpoint/list-available-accents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Localize Voice\",\"item\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice#apireference\",\"headline\":\"Localize Voice\",\"name\":\"Localize Voice\",\"description\":\"Adapt an existing voice to another language or accent.\",\"url\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gradium.ai/api-reference/endpoint/localize-voice#webpage\"},\"image\":\"https://docs.gradium.ai/og-image.png\",\"dateModified\":\"2026-10-08T08:51:31.852Z\",\"publisher\":{\"@id\":\"https://docs.gradium.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gradium.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gradium API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Gradium API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/localize-voice.md","siteName":"Gradium API","nav":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@gradium.ai"}]},"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Text-to-Speech","pages":[{"title":"TTS WebSocket Stream","openapi":"GET /speech/tts","playground":"none","href":"/api-reference/endpoint/tts-websocket"},{"title":"TTS POST Endpoint","openapi":"POST /speech/tts","href":"/api-reference/endpoint/tts-post"}]},{"group":"Speech-to-Text","pages":[{"title":"STT WebSocket Stream","openapi":"GET /speech/asr","playground":"none","href":"/api-reference/endpoint/stt-websocket"},{"title":"STT POST Endpoint","openapi":"POST /speech/asr","href":"/api-reference/endpoint/stt-post"}]},{"group":"Speech-to-Speech","pages":[{"title":"S2S WebSocket Stream","openapi":"GET /speech/s2s","playground":"none","href":"/api-reference/endpoint/s2s-websocket"}]},{"group":"Voices","pages":[{"title":"Create Voice","openapi":"POST /voices/","href":"/api-reference/endpoint/create-voice"},{"title":"Get Voices","openapi":"GET /voices/","href":"/api-reference/endpoint/get-voices"},{"title":"Get Voice","openapi":"GET /voices/{voice_uid}","href":"/api-reference/endpoint/get-voice"},{"title":"Update Voice","openapi":"PUT /voices/{voice_uid}","href":"/api-reference/endpoint/update-voice"},{"title":"Delete Voice","openapi":"DELETE /voices/{voice_uid}","href":"/api-reference/endpoint/delete-voice"}]},{"group":"Voice Design","pages":[{"title":"Generate Voice Candidates","openapi":"POST /voice-generator/generate","href":"/api-reference/endpoint/generate-voice"},{"title":"List Voice Candidates","openapi":"GET /voice-generator/embeddings","href":"/api-reference/endpoint/list-voice-embeddings"},{"title":"Create Voice From Candidate","openapi":"POST /voices/from-embedding","href":"/api-reference/endpoint/create-voice-from-embedding"},{"title":"Delete Voice Candidate","openapi":"DELETE /voice-generator/embeddings/{embedding_id}","href":"/api-reference/endpoint/delete-voice-embedding"}]},{"group":"Voice Enhance","pages":[{"title":"Enhance Voice","openapi":"POST /voice-generator/enhance","href":"/api-reference/endpoint/enhance-voice"}]},{"group":"Voice Localization","pages":[{"title":"List Available Accents","openapi":"GET /voice-generator/available-accents","description":"The accents a localization can target, per language.","href":"/api-reference/endpoint/list-available-accents"},{"title":"Localize Voice","openapi":"POST /voice-generator/localize","href":"/api-reference/endpoint/localize-voice"}]},{"group":"Pronunciations","pages":[{"title":"Create Pronunciation Dictionary","openapi":"POST /pronunciations/","description":"Create a Gradium pronunciation dictionary with language-specific rewrite rules.","href":"/api-reference/endpoint/create-pronunciation"},{"title":"List Pronunciation Dictionaries","openapi":"GET /pronunciations/","href":"/api-reference/endpoint/list-pronunciations"},{"title":"Get Pronunciation Dictionary","openapi":"GET /pronunciations/{uid}","href":"/api-reference/endpoint/get-pronunciation"},{"title":"Update Pronunciation Dictionary","openapi":"PUT /pronunciations/{uid}","href":"/api-reference/endpoint/update-pronunciation"},{"title":"Delete Pronunciation Dictionary","openapi":"DELETE /pronunciations/{uid}","href":"/api-reference/endpoint/delete-pronunciation"}]},{"group":"Metering","pages":[{"title":"Get Credits","openapi":"GET /usages/credits","href":"/api-reference/endpoint/get-credits"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/guides/release-notes/2026-11"}]}]},{"language":"fr","footer":{"socials":{"discord":"https://discord.com/invite/bcysuPRzXE"},"links":[{"header":"Sécurité","items":[{"label":"Sécurité et conformité","href":"/fr/guides/security"},{"label":"Trust Center","href":"https://trust.gradium.ai/"}]}]},"navbar":{"links":[{"href":"mailto:support@gradium.ai","label":"Support"}]},"pages":[{"title":"fr","href":"/fr/api-reference/endpoint/localize-voice"}]}]},"basePath":"","title":"Localize Voice - Gradium API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}