Any created voices are private to your account.Uses multipart/form-data encoding to provide the name of the voice along with an audio file containing the voice to be used for cloning.
Currently, we support one cloned voice per account. If you need more cloned voices, please reach out.
Authorizations
X-API-Key
string
header
required
API key
Body
multipart/form-dataapplication/json
file
file
required
An audio file containing a sample of the voice to clone.
name
string
required
Name for the cloned voice. Must be unique within your account.
Example:
"My Custom Voice"
description
string
Optional description for the voice. If not provided, a default description will be generated.
Example:
"Voice recorded on Jan 1, 2024"
language
string
default:en
BCP47 language code for the language used in the recording.
Example:
"en-US"
Response
201 - application/json
voiceId
string<uuid>
required
read-only
name
string
required
Maximum string length: 40
languageLabel
string | null
required
read-only
Human-readable language label with flag emoji and English name (e.g., 'πΊπΈ English (United States)').
previewUrl
string<uri>
required
read-only
ownership
enum<string>
required
Available options:
public,
private
billingStyle
enum<string>
required
How billing works for this voice.
VOICE_BILLING_STYLE_INCLUDED - The cost of this voice is included in the call cost. There are no additional charges for it.
VOICE_BILLING_STYLE_EXTERNAL - This voice requires an API key for its provider, who will bill for usage separately.
Available options:
VOICE_BILLING_STYLE_INCLUDED,
VOICE_BILLING_STYLE_EXTERNAL
provider
string | null
required
read-only
definition
object
required
A voice not known to Ultravox Realtime that can nonetheless be used for a call.
Such voices are significantly less validated than normal voices and you'll be
responsible for your own TTS-related errors.
Exactly one field must be set.
Show child attributes
replacementFor
string<uuid> | null
required
read-only
The voice this one will replace if its replacement is accepted.
replacedBy
string<uuid> | null
required
read-only
A replacement for this voice that can be accepted to switch this voice to it.
description
string | null
Maximum string length: 240
primaryLanguage
string | null
BCP47 language code for the primary language supported by this voice.
Maximum string length: 10
βI
curl --request POST \--url https://api.ultravox.ai/api/voices \--header 'Content-Type: multipart/form-data' \--header 'X-API-Key: <your-api-key>' \--form 'file=@/path/to/voice.mp3' \--form 'name=My Custom Voice' \--form 'description=Voice recorded on Jan 1, 2024'
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Ultravox Docs","colors":{"primary":"#5E92FF","light":"#FBFBFB","dark":"#5E92FF"},"logo":{"light":"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/images/UV%20Logo%20Horizontal%20Black.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=5eccb0a0c1b64983c2047f655e60aceb","dark":"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/images/UV%20Logo%20Horizontal%20White.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=18734dbcb147cdb1bcfd5349f4c0f2dd"},"favicon":"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/favicon.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=ff1442c06ee968ef7f32ce37590ca6a6","api":{"openapi":"https://api.ultravox.ai/api/schema/","playground":{"display":"interactive"},"mdx":{"auth":{"method":"key","name":"X-API-Key"},"server":"https://api.ultravox.ai/api/"}},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"https://discord.gg/62X253zeWB","label":"Community"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.ultravox.ai?utm_source=docs"}},"footer":{"socials":{"discord":"https://discord.gg/62X253zeWB","github":"https://github.com/fixie-ai/ultravox","x":"https://x.com/fixieai"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"integrations":{"gtm":{"tagId":"GTM-NC5RGFMZ"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fixie-ff99b187","hasAudioNarration":false,"actualSubdomain":"fixie-ff99b187","customDomains":["docs.ultravox.ai"],"gitSource":{"type":"github","owner":"fixie-ai","repo":"ultradox","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af9c276587f8094bb3762a9","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":113},{"language":"default","tag":"Documentation","count":63},{"language":"default","tag":"Telephony","count":27},{"language":"default","tag":"Tools","count":22},{"language":"default","tag":"Calls, Messages, Stages","count":19},{"language":"default","tag":"Getting Started","count":16},{"language":"default","tag":"Corpora, Query, Sources","count":15},{"language":"default","tag":"Agents","count":14},{"language":"default","tag":"Voices","count":11},{"language":"default","tag":"Webhooks","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"a{color:#005e99;text-decoration:none;transition:color 0.2s ease-in-out}a:hover{color:#7cc8ec}dark a{color:#7cc8ec}.dark a:hover{color:#0077be}"}],"page":{"pagePath":"api-reference/voices/voices-post","slug":"/api-reference/voices/voices-post","pageMetadata":{"openapi":"post /api/voices","title":"Create (Clone) Voice","description":"Create a new cloned voice","playground":"none","href":"/api-reference/voices/voices-post"},"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: \"Create a new cloned voice\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const VoiceCloneLimit=({})=>{const{Note}=_provideComponents()||{};if(!Note)_missingMdxReference(`Note`,true);return _jsxs(Note,{children:[`Currently, we support one cloned voice per account. If you need more cloned voices, please `,_jsx(`a`,{href:`mailto:support@inworld.ai?subject=Additional%20Voices`,children:`reach out`}),`.`]})};function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{_MdxComponentBoundary}=_components;if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Any created voices are private to your account.`}),`\n`,_jsx(_components.p,{children:`Uses multipart/form-data encoding to provide the name of the voice along with an audio file containing the voice to be used for cloning.`}),`\n`,_jsx(_MdxComponentBoundary,{name:`VoiceCloneLimit`,children:_jsx(VoiceCloneLimit,{})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{VoiceCloneLimit,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /api/voices","title":"Create (Clone) Voice","description":"Create a new cloned voice","playground":"none","href":"/api-reference/voices/voices-post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"voices_create","description":"Create a new cloned voice","tags":["voices"],"requestBody":"9eb3e42e-c4d2-4054-9e33-c79306aca2e2","security":["438d3d5b-48de-4727-84a8-4d424bc76156"],"responses":{"201":"c71dd87a-e811-4690-9acb-47fbfba5d14e"},"x-codeSamples":[{"lang":"curl","source":"curl --request POST \\\n--url https://api.ultravox.ai/api/voices \\\n--header 'Content-Type: multipart/form-data' \\\n--header 'X-API-Key: \u003cyour-api-key>' \\\n--form 'file=@/path/to/voice.mp3' \\\n--form 'name=My Custom Voice' \\\n--form 'description=Voice recorded on Jan 1, 2024'"},{"lang":"curl","source":"curl --request POST \\\n--url https://api.ultravox.ai/api/voices \\\n--header 'Content-Type: application/json' \\\n--header 'X-API-Key: \u003cyour-api-key>' \\\n-d '{\"name\": \"My Custom Voice\", \"description\": \"Example ElevenLabs voice\", \"definition\": {\"elevenLabs\": {\"voiceId\": \"21m00Tcm4TlvDq8ikWAM\", \"model\": \"eleven_turbo_v2_5\"}} }'"}],"method":"post","type":"path","servers":["2882e0dc-7754-4ee9-b791-520a663ef6cd"],"path":"/api/voices","baseUrlOptions":["https://api.ultravox.ai"],"title":"","codeSamples":[{"lang":"curl","source":"curl --request POST \\\n--url https://api.ultravox.ai/api/voices \\\n--header 'Content-Type: multipart/form-data' \\\n--header 'X-API-Key: \u003cyour-api-key>' \\\n--form 'file=@/path/to/voice.mp3' \\\n--form 'name=My Custom Voice' \\\n--form 'description=Voice recorded on Jan 1, 2024'"},{"lang":"curl","source":"curl --request POST \\\n--url https://api.ultravox.ai/api/voices \\\n--header 'Content-Type: application/json' \\\n--header 'X-API-Key: \u003cyour-api-key>' \\\n-d '{\"name\": \"My Custom Voice\", \"description\": \"Example ElevenLabs voice\", \"definition\": {\"elevenLabs\": {\"voiceId\": \"21m00Tcm4TlvDq8ikWAM\", \"model\": \"eleven_turbo_v2_5\"}} }'"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"An audio file containing a sample of the voice to clone.","isRequired":true,"uniqueKey":"file","typeLabel":"file"},"name":{"type":"string","description":"Name for the cloned voice. Must be unique within your account.","example":"My Custom Voice","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"Optional description for the voice. If not provided, a default description will be generated.","example":"Voice recorded on Jan 1, 2024","uniqueKey":"description","typeLabel":"string"},"language":{"type":"string","description":"BCP47 language code for the language used in the recording.","example":"en-US","default":"en","uniqueKey":"language","typeLabel":"string"}},"required":["file","name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"file":"\u003cstring>","name":"My Custom Voice","description":"Voice recorded on Jan 1, 2024","language":"en-US"}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":40,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"definition":{"type":"object","properties":{"elevenLabs":{"type":"object","description":"A voice served by ElevenLabs.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in ElevenLabs.","uniqueKey":"definition.elevenLabs.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The ElevenLabs model to use.","uniqueKey":"definition.elevenLabs.model","typeLabel":"string"},"speed":{"type":"number","description":"The speaking rate. Must be between 0.7 and 1.2. Defaults to 1.\n See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.speed","format":"float","uniqueKey":"definition.elevenLabs.speed","typeLabel":"number\u003cfloat>"},"useSpeakerBoost":{"type":"boolean","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.use_speaker_boost","uniqueKey":"definition.elevenLabs.useSpeakerBoost","typeLabel":"boolean"},"style":{"type":"number","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.style","format":"float","uniqueKey":"definition.elevenLabs.style","typeLabel":"number\u003cfloat>"},"similarityBoost":{"type":"number","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.similarity_boost","format":"float","uniqueKey":"definition.elevenLabs.similarityBoost","typeLabel":"number\u003cfloat>"},"stability":{"type":"number","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.stability","format":"float","uniqueKey":"definition.elevenLabs.stability","typeLabel":"number\u003cfloat>"},"pronunciationDictionaries":{"type":"array","items":{"type":"object","properties":{"dictionaryId":{"type":"string","description":"The dictionary's ID.","uniqueKey":"definition.elevenLabs.pronunciationDictionaries.items.[INDEX].dictionaryId","typeLabel":"string"},"versionId":{"type":"string","description":"The dictionary's version.","uniqueKey":"definition.elevenLabs.pronunciationDictionaries.items.[INDEX].versionId","typeLabel":"string"}},"description":"A reference to a pronunciation dictionary within ElevenLabs.","uniqueKey":"definition.elevenLabs.pronunciationDictionaries.items.[INDEX]","typeLabel":"object"},"description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.pronunciation_dictionary_locators","uniqueKey":"definition.elevenLabs.pronunciationDictionaries","typeLabel":"object[]"},"optimizeStreamingLatency":{"type":"integer","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.query.optimize_streaming_latency.optimize_streaming_latency","format":"int32","uniqueKey":"definition.elevenLabs.optimizeStreamingLatency","typeLabel":"integer\u003cint32>"},"maxSampleRate":{"type":"integer","description":"The maximum sample rate Ultravox will try to use. ElevenLabs limits your allowed sample rate\n based on your tier. See https://elevenlabs.io/pricing#pricing-table (and click \"Show API details\")","format":"int32","uniqueKey":"definition.elevenLabs.maxSampleRate","typeLabel":"integer\u003cint32>"},"enableSsmlParsing":{"type":"boolean","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/v-1-text-to-speech-voice-id-stream-input#request.query.enable_ssml_parsing","uniqueKey":"definition.elevenLabs.enableSsmlParsing","typeLabel":"boolean"}},"uniqueKey":"definition.elevenLabs","typeLabel":"object"},"cartesia":{"type":"object","description":"A voice served by Cartesia.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in Cartesia.","uniqueKey":"definition.cartesia.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The Cartesia model to use.","uniqueKey":"definition.cartesia.model","typeLabel":"string"},"speed":{"type":"number","description":"(Deprecated) The speaking rate. Must be between -1 and 1. Defaults to 0.","format":"float","uniqueKey":"definition.cartesia.speed","typeLabel":"number\u003cfloat>"},"emotion":{"type":"string","description":"(Deprecated) Use generation_config.emotion instead.","uniqueKey":"definition.cartesia.emotion","typeLabel":"string"},"emotions":{"type":"array","items":{"type":"string","uniqueKey":"definition.cartesia.emotions.items.[INDEX]","typeLabel":"string"},"description":"(Deprecated) Use generation_config.emotion instead.","uniqueKey":"definition.cartesia.emotions","typeLabel":"string[]"},"generationConfig":{"type":"object","description":"Configure the various attributes of the generated speech.","properties":{"volume":{"type":"number","description":"Adjust the volume of the generated speech between 0.5x and 2.0x the original volume (default is 1.0x). Valid values are between [0.5, 2.0] inclusive.","format":"float","uniqueKey":"definition.cartesia.generationConfig.volume","typeLabel":"number\u003cfloat>"},"speed":{"type":"number","description":"Adjust the speed of the generated speech between 0.6x and 2.0x the original speed (default is 1.0x). Valid values are between [0.6, 1.5] inclusive.","format":"float","uniqueKey":"definition.cartesia.generationConfig.speed","typeLabel":"number\u003cfloat>"},"emotion":{"type":"string","description":"The primary emotions are neutral, calm, angry, content, sad, scared. For more options, see Prompting Sonic-3.","uniqueKey":"definition.cartesia.generationConfig.emotion","typeLabel":"string"},"pronunciationDictId":{"type":"string","description":"The ID of a pronunciation dictionary to use for the generation.\n Pronunciation dictionaries are supported by sonic-3 models and newer.\n See https://docs.cartesia.ai/build-with-cartesia/capability-guides/specify-custom-pronunciations","uniqueKey":"definition.cartesia.generationConfig.pronunciationDictId","typeLabel":"string"}},"uniqueKey":"definition.cartesia.generationConfig","typeLabel":"object"}},"uniqueKey":"definition.cartesia","typeLabel":"object"},"lmnt":{"type":"object","description":"A voice served by LMNT.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in LMNT.","uniqueKey":"definition.lmnt.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The LMNT model to use.","uniqueKey":"definition.lmnt.model","typeLabel":"string"},"speed":{"type":"number","description":"The speaking rate. Must be between 0.25 and 2. Defaults to 1.\n See https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-speed","format":"float","uniqueKey":"definition.lmnt.speed","typeLabel":"number\u003cfloat>"},"conversational":{"type":"boolean","description":"See https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-conversational","uniqueKey":"definition.lmnt.conversational","typeLabel":"boolean"}},"uniqueKey":"definition.lmnt","typeLabel":"object"},"google":{"type":"object","description":"A voice served by Google, using bidirectional streaming.\n (For non-streaming or output-only streaming, use generic.)","properties":{"voiceId":{"type":"string","description":"The ID (name) of the voice in Google, e.g. \"en-US-Chirp3-HD-Charon\".","uniqueKey":"definition.google.voiceId","typeLabel":"string"},"speakingRate":{"type":"number","description":"The speaking rate. Must be between 0.25 and 2. Defaults to 1.\n See https://cloud.google.com/python/docs/reference/texttospeech/latest/google.cloud.texttospeech_v1.types.StreamingAudioConfig","format":"float","uniqueKey":"definition.google.speakingRate","typeLabel":"number\u003cfloat>"}},"uniqueKey":"definition.google","typeLabel":"object"},"inworld":{"type":"object","description":"A voice served by Inworld, using bidirectional streaming.\n (For non-streaming or output-only streaming, use generic.)","properties":{"voiceId":{"type":"string","description":"The ID of the voice in Inworld.","uniqueKey":"definition.inworld.voiceId","typeLabel":"string"},"modelId":{"type":"string","description":"The ID of the model to use for generations, e.g. \"inworld-tts-2\".\n See https://docs.inworld.ai/docs/tts/tts-models","uniqueKey":"definition.inworld.modelId","typeLabel":"string"},"speakingRate":{"type":"number","description":"The speaking rate. Must be between 0.5 and 1.5. Defaults to 1.\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-audio-config-speaking-rate","format":"float","uniqueKey":"definition.inworld.speakingRate","typeLabel":"number\u003cfloat>"},"temperature":{"type":"number","description":"How much randomness to use when sampling audio tokens. Must be between 0.0 and 2.0.\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-temperature","format":"float","uniqueKey":"definition.inworld.temperature","typeLabel":"number\u003cfloat>"},"applyTextNormalization":{"type":"boolean","description":"Whether or not to apply text normalization. This should typically only be disabled if the\n agent is instructed to normalize text directly.\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-apply-text-normalization.","uniqueKey":"definition.inworld.applyTextNormalization","typeLabel":"boolean"},"deliveryMode":{"enum":["DELIVERY_MODE_UNSPECIFIED","DELIVERY_MODE_STABLE","DELIVERY_MODE_BALANCED","DELIVERY_MODE_CREATIVE"],"type":"string","description":"How to balance consistency and expressiveness in generated speech. Only used by\n inworld-tts-2 models (ignored for other models).\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-delivery-mode","format":"enum","uniqueKey":"definition.inworld.deliveryMode","typeLabel":"enum\u003cstring>"},"pronunciationDictionaryIds":{"type":"array","items":{"type":"string","uniqueKey":"definition.inworld.pronunciationDictionaryIds.items.[INDEX]","typeLabel":"string"},"description":"Full resource names of up to three unique Inworld pronunciation dictionaries,\n in priority order (first match wins):\n workspaces/{workspace}/pronunciationDictionaries/{dictionary}.\n Must be accessible with the voice's Inworld API key. Omit to use no dictionary.\n Requires an inworld-tts-2 model and a concrete language on the call; otherwise\n entries are ignored or the request is rejected.","uniqueKey":"definition.inworld.pronunciationDictionaryIds","typeLabel":"string[]"}},"uniqueKey":"definition.inworld","typeLabel":"object"},"respeecher":{"type":"object","description":"A voice served by Respeecher, using bidirectional streaming.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in Respeecher.","uniqueKey":"definition.respeecher.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The model to use, e.g. \"/v1/public/tts/ua-rt\" or \"/v1/public/tts/en-rt\"\n Requests will be sent to wss://api.respeecher.com{model}/tts/websocket.\n If not set, defaults to \"/v1/public/tts/en-rt\" for calls with an English\n language hint and \"/v1/public/tts/ua-rt\" otherwise.","uniqueKey":"definition.respeecher.model","typeLabel":"string"},"seed":{"type":"integer","description":"Random seed for reproducible generation.","format":"int32","uniqueKey":"definition.respeecher.seed","typeLabel":"integer\u003cint32>"},"temperature":{"type":"number","description":"Controls randomness of the output. Higher values produce more varied speech.\n If set, must be greater than or equal to 0.0.","format":"float","uniqueKey":"definition.respeecher.temperature","typeLabel":"number\u003cfloat>"},"topK":{"type":"integer","description":"Limits sampling to the top K most likely tokens.\n If set, must be exactly -1 or greater than 0.","format":"int32","uniqueKey":"definition.respeecher.topK","typeLabel":"integer\u003cint32>"},"topP":{"type":"number","description":"Limits sampling to tokens with cumulative probability up to this value.\n If set, must be greater than 0 and less than or equal to 1.0.","format":"float","uniqueKey":"definition.respeecher.topP","typeLabel":"number\u003cfloat>"},"minP":{"type":"number","description":"Minimum probability threshold for token sampling.\n If set, must be between 0.0 and 1.0, inclusive.","format":"float","uniqueKey":"definition.respeecher.minP","typeLabel":"number\u003cfloat>"},"presencePenalty":{"type":"number","description":"Penalty for tokens already present in the context.\n If set, must be between 0 and 2, inclusive.","format":"float","uniqueKey":"definition.respeecher.presencePenalty","typeLabel":"number\u003cfloat>"},"repetitionPenalty":{"type":"number","description":"Penalty for repeating tokens.\n If set, must be between 1 and 2, inclusive.","format":"float","uniqueKey":"definition.respeecher.repetitionPenalty","typeLabel":"number\u003cfloat>"},"frequencyPenalty":{"type":"number","description":"Penalty based on token frequency.\n If set, must be between 0 and 2, inclusive.","format":"float","uniqueKey":"definition.respeecher.frequencyPenalty","typeLabel":"number\u003cfloat>"}},"uniqueKey":"definition.respeecher","typeLabel":"object"},"generic":{"type":"object","description":"A voice served by a generic REST-based TTS API.","properties":{"url":{"type":"string","description":"The endpoint to which requests are sent.","uniqueKey":"definition.generic.url","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"definition.generic.headers.additionalProperties","typeLabel":"string"},"description":"Headers to include in the request.","uniqueKey":"definition.generic.headers","typeLabel":"object"},"body":{"type":"object","description":"The request body to send. Some field should include a placeholder for text\n represented as {text}. The placeholder will be replaced with the text to synthesize.","uniqueKey":"definition.generic.body","typeLabel":"object"},"responseSampleRate":{"type":"integer","description":"The sample rate of the audio returned by the API.","format":"int32","uniqueKey":"definition.generic.responseSampleRate","typeLabel":"integer\u003cint32>"},"responseWordsPerMinute":{"type":"integer","description":"An estimate of the speaking rate of the returned audio in words per minute. This is\n used for transcript timing while audio is streamed in the response. (Once the response\n is complete, Ultravox Realtime uses the real audio duration to adjust the timing.)\n Defaults to 150 and is unused for non-streaming responses.","format":"int32","uniqueKey":"definition.generic.responseWordsPerMinute","typeLabel":"integer\u003cint32>"},"responseMimeType":{"type":"string","description":"The real mime type of the content returned by the API. If unset, the Content-Type response header\n will be used. This is useful for APIs whose response bodies don't strictly adhere to what the\n API claims via header. For example, if your API claims to return audio/wav but omits the WAV\n header (thus really returning raw PCM), set this to audio/l16. Similarly, if your API claims to\n return JSON but actually streams JSON Lines, set this to application/jsonl.","uniqueKey":"definition.generic.responseMimeType","typeLabel":"string"},"jsonAudioFieldPath":{"type":"string","description":"For JSON responses, the path to the field containing base64-encoded audio data. The data must\n be PCM audio, optionally with a WAV header.","uniqueKey":"definition.generic.jsonAudioFieldPath","typeLabel":"string"},"jsonByteEncoding":{"enum":["JSON_BYTE_ENCODING_UNSPECIFIED","JSON_BYTE_ENCODING_BASE64","JSON_BYTE_ENCODING_HEX"],"type":"string","description":"For JSON responses, how audio bytes are encoded into the json_audio_field_path string.\n Defaults to base64. Also supports hex.","format":"enum","uniqueKey":"definition.generic.jsonByteEncoding","typeLabel":"enum\u003cstring>"}},"uniqueKey":"definition.generic","typeLabel":"object"}},"description":"A voice not known to Ultravox Realtime that can nonetheless be used for a call.\n Such voices are significantly less validated than normal voices and you'll be\n responsible for your own TTS-related errors.\n Exactly one field must be set.","isRequired":true,"uniqueKey":"definition","typeLabel":"object"},"description":{"oneOf":[{"type":"string","maxLength":240,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":240,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"primaryLanguage":{"oneOf":[{"type":"string","description":"BCP47 language code for the primary language supported by this voice.","maxLength":10,"uniqueKey":"primaryLanguage.oneOf.0","typeLabel":"string"},{"type":"null","description":"BCP47 language code for the primary language supported by this voice.","maxLength":10,"uniqueKey":"primaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"primaryLanguage","typeLabel":"string | null"}},"required":["billingStyle","definition","languageLabel","name","ownership","previewUrl","provider","replacedBy","replacementFor","voiceId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","definition":{"elevenLabs":{"voiceId":"\u003cstring>","model":"\u003cstring>","speed":123,"useSpeakerBoost":true,"style":123,"similarityBoost":123,"stability":123,"pronunciationDictionaries":[{"dictionaryId":"\u003cstring>","versionId":"\u003cstring>"}],"optimizeStreamingLatency":123,"maxSampleRate":123,"enableSsmlParsing":true},"cartesia":{"voiceId":"\u003cstring>","model":"\u003cstring>","speed":123,"emotion":"\u003cstring>","emotions":["\u003cstring>"],"generationConfig":{"volume":123,"speed":123,"emotion":"\u003cstring>","pronunciationDictId":"\u003cstring>"}},"lmnt":{"voiceId":"\u003cstring>","model":"\u003cstring>","speed":123,"conversational":true},"google":{"voiceId":"\u003cstring>","speakingRate":123},"inworld":{"voiceId":"\u003cstring>","modelId":"\u003cstring>","speakingRate":123,"temperature":123,"applyTextNormalization":true,"pronunciationDictionaryIds":["\u003cstring>"]},"respeecher":{"voiceId":"\u003cstring>","model":"\u003cstring>","seed":123,"temperature":123,"topK":123,"topP":123,"minP":123,"presencePenalty":123,"repetitionPenalty":123,"frequencyPenalty":123},"generic":{"url":"\u003cstring>","headers":{},"body":{},"responseSampleRate":123,"responseWordsPerMinute":123,"responseMimeType":"\u003cstring>","jsonAudioFieldPath":"\u003cstring>"}},"description":"\u003cstring>","primaryLanguage":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c71dd87a-e811-4690-9acb-47fbfba5d14e":{"content":{"application/json":{"schema":{"type":"object","properties":{"voiceId":{"type":"string","format":"uuid","readOnly":true,"isRequired":true,"uniqueKey":"voiceId","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":40,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"languageLabel":{"oneOf":[{"type":"string","readOnly":true,"description":"Human-readable language label with flag emoji and English name (e.g., 'πΊπΈ English (United States)').","isRequired":true,"uniqueKey":"languageLabel.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Human-readable language label with flag emoji and English name (e.g., 'πΊπΈ English (United States)').","isRequired":true,"uniqueKey":"languageLabel.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"languageLabel","typeLabel":"string | null"},"previewUrl":{"format":"uri","type":"string","readOnly":true,"isRequired":true,"uniqueKey":"previewUrl","typeLabel":"string\u003curi>"},"ownership":{"type":"string","enum":["public","private"],"isRequired":true,"uniqueKey":"ownership","typeLabel":"enum\u003cstring>"},"billingStyle":{"type":"string","description":"How billing works for this voice.\nVOICE_BILLING_STYLE_INCLUDED - The cost of this voice is included in the call cost. There are no additional charges for it.\nVOICE_BILLING_STYLE_EXTERNAL - This voice requires an API key for its provider, who will bill for usage separately.","enum":["VOICE_BILLING_STYLE_INCLUDED","VOICE_BILLING_STYLE_EXTERNAL"],"isRequired":true,"uniqueKey":"billingStyle","typeLabel":"enum\u003cstring>"},"provider":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"provider.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"provider.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"provider","typeLabel":"string | null"},"definition":{"type":"object","properties":{"elevenLabs":{"type":"object","description":"A voice served by ElevenLabs.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in ElevenLabs.","uniqueKey":"definition.elevenLabs.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The ElevenLabs model to use.","uniqueKey":"definition.elevenLabs.model","typeLabel":"string"},"speed":{"type":"number","description":"The speaking rate. Must be between 0.7 and 1.2. Defaults to 1.\n See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.speed","format":"float","uniqueKey":"definition.elevenLabs.speed","typeLabel":"number\u003cfloat>"},"useSpeakerBoost":{"type":"boolean","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.use_speaker_boost","uniqueKey":"definition.elevenLabs.useSpeakerBoost","typeLabel":"boolean"},"style":{"type":"number","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.style","format":"float","uniqueKey":"definition.elevenLabs.style","typeLabel":"number\u003cfloat>"},"similarityBoost":{"type":"number","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.similarity_boost","format":"float","uniqueKey":"definition.elevenLabs.similarityBoost","typeLabel":"number\u003cfloat>"},"stability":{"type":"number","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.voice_settings.stability","format":"float","uniqueKey":"definition.elevenLabs.stability","typeLabel":"number\u003cfloat>"},"pronunciationDictionaries":{"type":"array","items":{"type":"object","properties":{"dictionaryId":{"type":"string","description":"The dictionary's ID.","uniqueKey":"definition.elevenLabs.pronunciationDictionaries.items.[INDEX].dictionaryId","typeLabel":"string"},"versionId":{"type":"string","description":"The dictionary's version.","uniqueKey":"definition.elevenLabs.pronunciationDictionaries.items.[INDEX].versionId","typeLabel":"string"}},"description":"A reference to a pronunciation dictionary within ElevenLabs.","uniqueKey":"definition.elevenLabs.pronunciationDictionaries.items.[INDEX]","typeLabel":"object"},"description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.body.pronunciation_dictionary_locators","uniqueKey":"definition.elevenLabs.pronunciationDictionaries","typeLabel":"object[]"},"optimizeStreamingLatency":{"type":"integer","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/convert#request.query.optimize_streaming_latency.optimize_streaming_latency","format":"int32","uniqueKey":"definition.elevenLabs.optimizeStreamingLatency","typeLabel":"integer\u003cint32>"},"maxSampleRate":{"type":"integer","description":"The maximum sample rate Ultravox will try to use. ElevenLabs limits your allowed sample rate\n based on your tier. See https://elevenlabs.io/pricing#pricing-table (and click \"Show API details\")","format":"int32","uniqueKey":"definition.elevenLabs.maxSampleRate","typeLabel":"integer\u003cint32>"},"enableSsmlParsing":{"type":"boolean","description":"See https://elevenlabs.io/docs/api-reference/text-to-speech/v-1-text-to-speech-voice-id-stream-input#request.query.enable_ssml_parsing","uniqueKey":"definition.elevenLabs.enableSsmlParsing","typeLabel":"boolean"}},"uniqueKey":"definition.elevenLabs","typeLabel":"object"},"cartesia":{"type":"object","description":"A voice served by Cartesia.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in Cartesia.","uniqueKey":"definition.cartesia.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The Cartesia model to use.","uniqueKey":"definition.cartesia.model","typeLabel":"string"},"speed":{"type":"number","description":"(Deprecated) The speaking rate. Must be between -1 and 1. Defaults to 0.","format":"float","uniqueKey":"definition.cartesia.speed","typeLabel":"number\u003cfloat>"},"emotion":{"type":"string","description":"(Deprecated) Use generation_config.emotion instead.","uniqueKey":"definition.cartesia.emotion","typeLabel":"string"},"emotions":{"type":"array","items":{"type":"string","uniqueKey":"definition.cartesia.emotions.items.[INDEX]","typeLabel":"string"},"description":"(Deprecated) Use generation_config.emotion instead.","uniqueKey":"definition.cartesia.emotions","typeLabel":"string[]"},"generationConfig":{"type":"object","description":"Configure the various attributes of the generated speech.","properties":{"volume":{"type":"number","description":"Adjust the volume of the generated speech between 0.5x and 2.0x the original volume (default is 1.0x). Valid values are between [0.5, 2.0] inclusive.","format":"float","uniqueKey":"definition.cartesia.generationConfig.volume","typeLabel":"number\u003cfloat>"},"speed":{"type":"number","description":"Adjust the speed of the generated speech between 0.6x and 2.0x the original speed (default is 1.0x). Valid values are between [0.6, 1.5] inclusive.","format":"float","uniqueKey":"definition.cartesia.generationConfig.speed","typeLabel":"number\u003cfloat>"},"emotion":{"type":"string","description":"The primary emotions are neutral, calm, angry, content, sad, scared. For more options, see Prompting Sonic-3.","uniqueKey":"definition.cartesia.generationConfig.emotion","typeLabel":"string"},"pronunciationDictId":{"type":"string","description":"The ID of a pronunciation dictionary to use for the generation.\n Pronunciation dictionaries are supported by sonic-3 models and newer.\n See https://docs.cartesia.ai/build-with-cartesia/capability-guides/specify-custom-pronunciations","uniqueKey":"definition.cartesia.generationConfig.pronunciationDictId","typeLabel":"string"}},"uniqueKey":"definition.cartesia.generationConfig","typeLabel":"object"}},"uniqueKey":"definition.cartesia","typeLabel":"object"},"lmnt":{"type":"object","description":"A voice served by LMNT.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in LMNT.","uniqueKey":"definition.lmnt.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The LMNT model to use.","uniqueKey":"definition.lmnt.model","typeLabel":"string"},"speed":{"type":"number","description":"The speaking rate. Must be between 0.25 and 2. Defaults to 1.\n See https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-speed","format":"float","uniqueKey":"definition.lmnt.speed","typeLabel":"number\u003cfloat>"},"conversational":{"type":"boolean","description":"See https://docs.lmnt.com/api-reference/speech/synthesize-speech-bytes#body-conversational","uniqueKey":"definition.lmnt.conversational","typeLabel":"boolean"}},"uniqueKey":"definition.lmnt","typeLabel":"object"},"google":{"type":"object","description":"A voice served by Google, using bidirectional streaming.\n (For non-streaming or output-only streaming, use generic.)","properties":{"voiceId":{"type":"string","description":"The ID (name) of the voice in Google, e.g. \"en-US-Chirp3-HD-Charon\".","uniqueKey":"definition.google.voiceId","typeLabel":"string"},"speakingRate":{"type":"number","description":"The speaking rate. Must be between 0.25 and 2. Defaults to 1.\n See https://cloud.google.com/python/docs/reference/texttospeech/latest/google.cloud.texttospeech_v1.types.StreamingAudioConfig","format":"float","uniqueKey":"definition.google.speakingRate","typeLabel":"number\u003cfloat>"}},"uniqueKey":"definition.google","typeLabel":"object"},"inworld":{"type":"object","description":"A voice served by Inworld, using bidirectional streaming.\n (For non-streaming or output-only streaming, use generic.)","properties":{"voiceId":{"type":"string","description":"The ID of the voice in Inworld.","uniqueKey":"definition.inworld.voiceId","typeLabel":"string"},"modelId":{"type":"string","description":"The ID of the model to use for generations, e.g. \"inworld-tts-2\".\n See https://docs.inworld.ai/docs/tts/tts-models","uniqueKey":"definition.inworld.modelId","typeLabel":"string"},"speakingRate":{"type":"number","description":"The speaking rate. Must be between 0.5 and 1.5. Defaults to 1.\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-audio-config-speaking-rate","format":"float","uniqueKey":"definition.inworld.speakingRate","typeLabel":"number\u003cfloat>"},"temperature":{"type":"number","description":"How much randomness to use when sampling audio tokens. Must be between 0.0 and 2.0.\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-temperature","format":"float","uniqueKey":"definition.inworld.temperature","typeLabel":"number\u003cfloat>"},"applyTextNormalization":{"type":"boolean","description":"Whether or not to apply text normalization. This should typically only be disabled if the\n agent is instructed to normalize text directly.\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-apply-text-normalization.","uniqueKey":"definition.inworld.applyTextNormalization","typeLabel":"boolean"},"deliveryMode":{"enum":["DELIVERY_MODE_UNSPECIFIED","DELIVERY_MODE_STABLE","DELIVERY_MODE_BALANCED","DELIVERY_MODE_CREATIVE"],"type":"string","description":"How to balance consistency and expressiveness in generated speech. Only used by\n inworld-tts-2 models (ignored for other models).\n See https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream#body-delivery-mode","format":"enum","uniqueKey":"definition.inworld.deliveryMode","typeLabel":"enum\u003cstring>"},"pronunciationDictionaryIds":{"type":"array","items":{"type":"string","uniqueKey":"definition.inworld.pronunciationDictionaryIds.items.[INDEX]","typeLabel":"string"},"description":"Full resource names of up to three unique Inworld pronunciation dictionaries,\n in priority order (first match wins):\n workspaces/{workspace}/pronunciationDictionaries/{dictionary}.\n Must be accessible with the voice's Inworld API key. Omit to use no dictionary.\n Requires an inworld-tts-2 model and a concrete language on the call; otherwise\n entries are ignored or the request is rejected.","uniqueKey":"definition.inworld.pronunciationDictionaryIds","typeLabel":"string[]"}},"uniqueKey":"definition.inworld","typeLabel":"object"},"respeecher":{"type":"object","description":"A voice served by Respeecher, using bidirectional streaming.","properties":{"voiceId":{"type":"string","description":"The ID of the voice in Respeecher.","uniqueKey":"definition.respeecher.voiceId","typeLabel":"string"},"model":{"type":"string","description":"The model to use, e.g. \"/v1/public/tts/ua-rt\" or \"/v1/public/tts/en-rt\"\n Requests will be sent to wss://api.respeecher.com{model}/tts/websocket.\n If not set, defaults to \"/v1/public/tts/en-rt\" for calls with an English\n language hint and \"/v1/public/tts/ua-rt\" otherwise.","uniqueKey":"definition.respeecher.model","typeLabel":"string"},"seed":{"type":"integer","description":"Random seed for reproducible generation.","format":"int32","uniqueKey":"definition.respeecher.seed","typeLabel":"integer\u003cint32>"},"temperature":{"type":"number","description":"Controls randomness of the output. Higher values produce more varied speech.\n If set, must be greater than or equal to 0.0.","format":"float","uniqueKey":"definition.respeecher.temperature","typeLabel":"number\u003cfloat>"},"topK":{"type":"integer","description":"Limits sampling to the top K most likely tokens.\n If set, must be exactly -1 or greater than 0.","format":"int32","uniqueKey":"definition.respeecher.topK","typeLabel":"integer\u003cint32>"},"topP":{"type":"number","description":"Limits sampling to tokens with cumulative probability up to this value.\n If set, must be greater than 0 and less than or equal to 1.0.","format":"float","uniqueKey":"definition.respeecher.topP","typeLabel":"number\u003cfloat>"},"minP":{"type":"number","description":"Minimum probability threshold for token sampling.\n If set, must be between 0.0 and 1.0, inclusive.","format":"float","uniqueKey":"definition.respeecher.minP","typeLabel":"number\u003cfloat>"},"presencePenalty":{"type":"number","description":"Penalty for tokens already present in the context.\n If set, must be between 0 and 2, inclusive.","format":"float","uniqueKey":"definition.respeecher.presencePenalty","typeLabel":"number\u003cfloat>"},"repetitionPenalty":{"type":"number","description":"Penalty for repeating tokens.\n If set, must be between 1 and 2, inclusive.","format":"float","uniqueKey":"definition.respeecher.repetitionPenalty","typeLabel":"number\u003cfloat>"},"frequencyPenalty":{"type":"number","description":"Penalty based on token frequency.\n If set, must be between 0 and 2, inclusive.","format":"float","uniqueKey":"definition.respeecher.frequencyPenalty","typeLabel":"number\u003cfloat>"}},"uniqueKey":"definition.respeecher","typeLabel":"object"},"generic":{"type":"object","description":"A voice served by a generic REST-based TTS API.","properties":{"url":{"type":"string","description":"The endpoint to which requests are sent.","uniqueKey":"definition.generic.url","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"definition.generic.headers.additionalProperties","typeLabel":"string"},"description":"Headers to include in the request.","uniqueKey":"definition.generic.headers","typeLabel":"object"},"body":{"type":"object","description":"The request body to send. Some field should include a placeholder for text\n represented as {text}. The placeholder will be replaced with the text to synthesize.","uniqueKey":"definition.generic.body","typeLabel":"object"},"responseSampleRate":{"type":"integer","description":"The sample rate of the audio returned by the API.","format":"int32","uniqueKey":"definition.generic.responseSampleRate","typeLabel":"integer\u003cint32>"},"responseWordsPerMinute":{"type":"integer","description":"An estimate of the speaking rate of the returned audio in words per minute. This is\n used for transcript timing while audio is streamed in the response. (Once the response\n is complete, Ultravox Realtime uses the real audio duration to adjust the timing.)\n Defaults to 150 and is unused for non-streaming responses.","format":"int32","uniqueKey":"definition.generic.responseWordsPerMinute","typeLabel":"integer\u003cint32>"},"responseMimeType":{"type":"string","description":"The real mime type of the content returned by the API. If unset, the Content-Type response header\n will be used. This is useful for APIs whose response bodies don't strictly adhere to what the\n API claims via header. For example, if your API claims to return audio/wav but omits the WAV\n header (thus really returning raw PCM), set this to audio/l16. Similarly, if your API claims to\n return JSON but actually streams JSON Lines, set this to application/jsonl.","uniqueKey":"definition.generic.responseMimeType","typeLabel":"string"},"jsonAudioFieldPath":{"type":"string","description":"For JSON responses, the path to the field containing base64-encoded audio data. The data must\n be PCM audio, optionally with a WAV header.","uniqueKey":"definition.generic.jsonAudioFieldPath","typeLabel":"string"},"jsonByteEncoding":{"enum":["JSON_BYTE_ENCODING_UNSPECIFIED","JSON_BYTE_ENCODING_BASE64","JSON_BYTE_ENCODING_HEX"],"type":"string","description":"For JSON responses, how audio bytes are encoded into the json_audio_field_path string.\n Defaults to base64. Also supports hex.","format":"enum","uniqueKey":"definition.generic.jsonByteEncoding","typeLabel":"enum\u003cstring>"}},"uniqueKey":"definition.generic","typeLabel":"object"}},"description":"A voice not known to Ultravox Realtime that can nonetheless be used for a call.\n Such voices are significantly less validated than normal voices and you'll be\n responsible for your own TTS-related errors.\n Exactly one field must be set.","isRequired":true,"uniqueKey":"definition","typeLabel":"object"},"replacementFor":{"oneOf":[{"type":"string","format":"uuid","readOnly":true,"description":"The voice this one will replace if its replacement is accepted.","isRequired":true,"uniqueKey":"replacementFor.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","readOnly":true,"description":"The voice this one will replace if its replacement is accepted.","isRequired":true,"uniqueKey":"replacementFor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"replacementFor","typeLabel":"string\u003cuuid> | null"},"replacedBy":{"oneOf":[{"format":"uuid","type":"string","readOnly":true,"description":"A replacement for this voice that can be accepted to switch this voice to it.","isRequired":true,"uniqueKey":"replacedBy.oneOf.0","typeLabel":"string\u003cuuid>"},{"format":"uuid","type":"null","readOnly":true,"description":"A replacement for this voice that can be accepted to switch this voice to it.","isRequired":true,"uniqueKey":"replacedBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"replacedBy","typeLabel":"string\u003cuuid> | null"},"description":{"oneOf":[{"type":"string","maxLength":240,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":240,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"primaryLanguage":{"oneOf":[{"type":"string","description":"BCP47 language code for the primary language supported by this voice.","maxLength":10,"uniqueKey":"primaryLanguage.oneOf.0","typeLabel":"string"},{"type":"null","description":"BCP47 language code for the primary language supported by this voice.","maxLength":10,"uniqueKey":"primaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"primaryLanguage","typeLabel":"string | null"}},"required":["billingStyle","definition","languageLabel","name","ownership","previewUrl","provider","replacedBy","replacementFor","voiceId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"voiceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","languageLabel":"\u003cstring>","previewUrl":"\u003cstring>","ownership":"public","billingStyle":"VOICE_BILLING_STYLE_INCLUDED","provider":"\u003cstring>","definition":{"elevenLabs":{"voiceId":"\u003cstring>","model":"\u003cstring>","speed":123,"useSpeakerBoost":true,"style":123,"similarityBoost":123,"stability":123,"pronunciationDictionaries":[{"dictionaryId":"\u003cstring>","versionId":"\u003cstring>"}],"optimizeStreamingLatency":123,"maxSampleRate":123,"enableSsmlParsing":true},"cartesia":{"voiceId":"\u003cstring>","model":"\u003cstring>","speed":123,"emotion":"\u003cstring>","emotions":["\u003cstring>"],"generationConfig":{"volume":123,"speed":123,"emotion":"\u003cstring>","pronunciationDictId":"\u003cstring>"}},"lmnt":{"voiceId":"\u003cstring>","model":"\u003cstring>","speed":123,"conversational":true},"google":{"voiceId":"\u003cstring>","speakingRate":123},"inworld":{"voiceId":"\u003cstring>","modelId":"\u003cstring>","speakingRate":123,"temperature":123,"applyTextNormalization":true,"deliveryMode":"DELIVERY_MODE_UNSPECIFIED","pronunciationDictionaryIds":["\u003cstring>"]},"respeecher":{"voiceId":"\u003cstring>","model":"\u003cstring>","seed":123,"temperature":123,"topK":123,"topP":123,"minP":123,"presencePenalty":123,"repetitionPenalty":123,"frequencyPenalty":123},"generic":{"url":"\u003cstring>","headers":{},"body":{},"responseSampleRate":123,"responseWordsPerMinute":123,"responseMimeType":"\u003cstring>","jsonAudioFieldPath":"\u003cstring>","jsonByteEncoding":"JSON_BYTE_ENCODING_UNSPECIFIED"}},"replacementFor":"3c90c3cc-0d44-4b50-8888-8dd25736052a","replacedBy":"3c90c3cc-0d44-4b50-8888-8dd25736052a","description":"\u003cstring>","primaryLanguage":"\u003cstring>"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"438d3d5b-48de-4727-84a8-4d424bc76156":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"2882e0dc-7754-4ee9-b791-520a663ef6cd":{"url":"https://api.ultravox.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-Key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"https://api.ultravox.ai/api/schema/"},"subdomain":"fixie-ff99b187","siteName":"Ultravox Docs","title":"Create (Clone) Voice - Ultravox Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T20:22:53.747Z","originalFileLocation":"api-reference/voices/voices-post.mdx"},"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=\"system\"}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=\"Create a new cloned voice\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ultravox Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_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/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create (Clone) Voice - Ultravox Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new cloned voice\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ultravox Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ultravox.ai/api-reference/voices/voices-post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fixie-ff99b187.mintlify.site/_mintlify/api/og/v2?division=Voices\u0026amp;title=Create+%28Clone%29+Voice\u0026amp;description=Create+a+new+cloned+voice\u0026amp;theme=bb9f80014917be9d73b3c550\u0026amp;signature=2e3b66e396b74e8341dc94ccfad4667f756aa8a3f0af941ea12e1040ad4c175c\">\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=\"Create (Clone) Voice - Ultravox Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new cloned voice\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fixie-ff99b187.mintlify.site/_mintlify/api/og/v2?division=Voices\u0026amp;title=Create+%28Clone%29+Voice\u0026amp;description=Create+a+new+cloned+voice\u0026amp;theme=bb9f80014917be9d73b3c550\u0026amp;signature=2e3b66e396b74e8341dc94ccfad4667f756aa8a3f0af941ea12e1040ad4c175c\">\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/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ultravox Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E92FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ultravox.ai/api-reference/voices/voices-post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/voices/voices-post.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ultravox.ai/#organization\",\"name\":\"Ultravox Docs\",\"url\":\"https://docs.ultravox.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/images/UV%20Logo%20Horizontal%20Black.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=5eccb0a0c1b64983c2047f655e60aceb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ultravox.ai#website\",\"name\":\"Ultravox Docs\",\"url\":\"https://docs.ultravox.ai\",\"publisher\":{\"@id\":\"https://docs.ultravox.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ultravox.ai/api-reference/voices/voices-post#webpage\",\"url\":\"https://docs.ultravox.ai/api-reference/voices/voices-post\",\"name\":\"Create (Clone) Voice\",\"description\":\"Create a new cloned voice\",\"dateModified\":\"2026-10-20T20:22:53.747Z\",\"isPartOf\":{\"@id\":\"https://docs.ultravox.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ultravox.ai/api-reference/voices/voices-post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ultravox.ai/api-reference/voices/voices-post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Voices\",\"item\":\"https://docs.ultravox.ai/api-reference/voices/voices-list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create (Clone) Voice\",\"item\":\"https://docs.ultravox.ai/api-reference/voices/voices-post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ultravox.ai/api-reference/voices/voices-post#apireference\",\"headline\":\"Create (Clone) Voice\",\"name\":\"Create (Clone) Voice\",\"description\":\"Create a new cloned voice\",\"url\":\"https://docs.ultravox.ai/api-reference/voices/voices-post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ultravox.ai/api-reference/voices/voices-post#webpage\"},\"dateModified\":\"2026-10-20T20:22:53.747Z\",\"publisher\":{\"@id\":\"https://docs.ultravox.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ultravox.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ultravox Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ultravox Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/voices/voices-post.md","siteName":"Ultravox Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Ultravox REST API Overview","href":"/api-reference/introduction"}]},{"group":"Accounts","pages":[{"openapi":"get /api/accounts/me","title":"Get Account","href":"/api-reference/accounts/accounts-me-get"},{"openapi":"get /api/accounts/me/usage/calls","title":"Get Call Usage","href":"/api-reference/accounts/accounts-me-usage-calls-get"},{"openapi":"get /api/accounts/me/usage/concurrency","title":"Get Concurrency Usage","href":"/api-reference/accounts/accounts-me-usage-concurrency-get"},{"openapi":"patch /api/accounts/me/tts_api_keys","title":"Set TTS API keys","href":"/api-reference/accounts/accounts-me-tts-api-keys-partial-update"},{"openapi":"get /api/accounts/me/tts_api_keys","title":"Get Account TTS API Keys","href":"/api-reference/accounts/accounts-me-tts-api-keys-retrieve"}]},{"group":"Agents","pages":[{"openapi":"get /api/agents","title":"List Agents","href":"/api-reference/agents/agents-list"},{"openapi":"post /api/agents","title":"Create Agent","href":"/api-reference/agents/agents-post"},{"openapi":"get /api/agents/{agent_id}","title":"Get Agent","href":"/api-reference/agents/agents-get"},{"openapi":"patch /api/agents/{agent_id}","title":"Update Agent","href":"/api-reference/agents/agents-patch"},{"openapi":"delete /api/agents/{agent_id}","title":"Delete Agent","href":"/api-reference/agents/agents-delete"},{"openapi":"get /api/agents/{agent_id}/calls","title":"List Agent Calls","href":"/api-reference/agents/agents-calls-list"},{"openapi":"post /api/agents/{agent_id}/calls","title":"Create Agent Call","href":"/api-reference/agents/agents-calls-post"},{"group":"Scheduled Call Batches","tag":"NEW","expanded":true,"pages":[{"openapi":"get /api/agents/{agent_id}/scheduled_batches","title":"List Scheduled Call Batches","href":"/api-reference/agents/agents-scheduled-batches-list"},{"openapi":"post /api/agents/{agent_id}/scheduled_batches","title":"Create Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-post"},{"openapi":"get /api/agents/{agent_id}/scheduled_batches/{batch_id}","title":"Get Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-get"},{"openapi":"patch /api/agents/{agent_id}/scheduled_batches/{batch_id}","title":"Update Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-patch"},{"openapi":"delete /api/agents/{agent_id}/scheduled_batches/{batch_id}","title":"Delete Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-delete"},{"openapi":"get /api/agents/{agent_id}/scheduled_batches/{batch_id}/created_calls","title":"List Scheduled Call Batch Created Calls","href":"/api-reference/agents/agents-scheduled-batches-created-calls-list"},{"openapi":"get /api/agents/{agent_id}/scheduled_batches/{batch_id}/scheduled_calls","title":"List Scheduled Call Batch Scheduled Calls","href":"/api-reference/agents/agents-scheduled-batches-scheduled-calls-list"}]}]},{"group":"Calls, Messages, Stages","pages":[{"title":"Calls Overview","href":"/api-reference/calls/overview"},{"openapi":"get /api/calls","title":"List Calls","href":"/api-reference/calls/calls-list"},{"openapi":"get /api/calls/{call_id}","title":"Get Call","href":"/api-reference/calls/calls-get"},{"openapi":"post /api/calls","title":"Create Call","href":"/api-reference/calls/calls-post"},{"openapi":"delete /api/calls/{call_id}","title":"Delete Call","href":"/api-reference/calls/calls-delete"},{"openapi":"get /api/calls/{call_id}/messages","title":"List Call Messages","href":"/api-reference/calls/calls-messages-list"},{"openapi":"get /api/calls/{call_id}/tools","title":"List Call Tools","href":"/api-reference/calls/calls-tools-list"},{"openapi":"get /api/calls/{call_id}/triggers","title":"List Call Triggers","href":"/api-reference/calls/calls-triggers-list"},{"openapi":"get /api/calls/{call_id}/recording","title":"Get Call Recording","href":"/api-reference/calls/calls-recording-get"},{"openapi":"get /api/calls/{call_id}/stages","title":"List Call Stages","href":"/api-reference/calls/calls-stages-list"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}","title":"Get Call Stage","href":"/api-reference/calls/calls-stages-get"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}/messages","title":"List Call Stage Messages","href":"/api-reference/calls/calls-stages-messages-list"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}/tools","title":"List Call Stage Tools","href":"/api-reference/calls/calls-stages-tools-list"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}/messages/{call_stage_message_index}/audio","title":"Get Call Stage Message Audio","href":"/api-reference/calls/calls-stages-message-audio-get"},{"openapi":"get /api/deleted_calls","title":"List Deleted Calls","href":"/api-reference/calls/calls-deleted-calls-list"},{"openapi":"get /api/deleted_calls/{call_id}","title":"Get Deleted Call","href":"/api-reference/calls/calls-deleted-calls-get"},{"openapi":"get /api/calls/{call_id}/events","title":"List Call Events","href":"/api-reference/calls/calls-events-list"},{"openapi":"get /api/calls/{call_id}/sip_logs","title":"Get Sip Logs for a call","href":"/api-reference/calls/calls-sip-logs-get"},{"openapi":"post /api/calls/{call_id}/send_data_message","title":"Send Data Message to Call","href":"/api-reference/calls/calls-send-data-message-post"}]},{"group":"Corpora, Query, Sources","pages":[{"title":"Corpus Service (RAG) Overview","href":"/api-reference/corpora/overview"},{"openapi":"get /api/corpora","title":"List Corpora","href":"/api-reference/corpora/corpora-list"},{"openapi":"post /api/corpora","title":"Create Corpus","href":"/api-reference/corpora/corpora-post"},{"openapi":"get /api/corpora/{corpus_id}","title":"Get Corpus","href":"/api-reference/corpora/corpora-get"},{"openapi":"patch /api/corpora/{corpus_id}","title":"Update Corpus","href":"/api-reference/corpora/corpora-patch"},{"openapi":"delete /api/corpora/{corpus_id}","title":"Delete Corpus","href":"/api-reference/corpora/corpora-delete"},{"openapi":"post /api/corpora/{corpus_id}/query","title":"Query Corpus","href":"/api-reference/corpora/corpus-query"},{"openapi":"get /api/corpora/{corpus_id}/sources","title":"List Corpus Sources","href":"/api-reference/corpora/corpora-sources-list"},{"openapi":"post /api/corpora/{corpus_id}/sources","title":"Create Corpus Source","href":"/api-reference/corpora/corpora-sources-post"},{"openapi":"get /api/corpora/{corpus_id}/sources/{source_id}","title":"Get Corpus Source","href":"/api-reference/corpora/corpora-sources-get"},{"openapi":"patch /api/corpora/{corpus_id}/sources/{source_id}","title":"Update Corpus Source","href":"/api-reference/corpora/corpora-sources-patch"},{"openapi":"delete /api/corpora/{corpus_id}/sources/{source_id}","title":"Delete Corpus Source","href":"/api-reference/corpora/corpora-sources-delete"},{"openapi":"get /api/corpora/{corpus_id}/sources/{source_id}/documents","title":"List Corpus Source Documents","href":"/api-reference/corpora/corpora-sources-documents-list"},{"openapi":"get /api/corpora/{corpus_id}/sources/{source_id}/documents/{document_id}","title":"Get Corpus Source Document","href":"/api-reference/corpora/corpora-sources-documents-get"},{"openapi":"post /api/corpora/{corpus_id}/uploads","title":"Create Corpus File Upload","href":"/api-reference/corpora/corpora-uploads-post"}]},{"group":"Call Throttles","pages":[{"openapi":"get /api/call_throttles","title":"List Call Throttles","href":"/api-reference/call-throttles/call-throttles-list"},{"openapi":"get /api/call_throttles/{throttle_id}","title":"Get Call Throttle","href":"/api-reference/call-throttles/call-throttles-get"},{"openapi":"post /api/call_throttles","title":"Create Call Throttle","href":"/api-reference/call-throttles/call-throttles-post"},{"openapi":"put /api/call_throttles/{throttle_id}","title":"Update Call Throttle","href":"/api-reference/call-throttles/call-throttles-put"},{"openapi":"patch /api/call_throttles/{throttle_id}","title":"Patch Call Throttle","href":"/api-reference/call-throttles/call-throttles-patch"},{"openapi":"delete /api/call_throttles/{throttle_id}","title":"Delete Call Throttle","href":"/api-reference/call-throttles/call-throttles-delete"}]},{"group":"Tools","pages":[{"openapi":"get /api/tools","title":"List Tools","href":"/api-reference/tools/tools-list"},{"openapi":"get /api/tools/{tool_id}","title":"Get Tool","href":"/api-reference/tools/tools-get"},{"openapi":"post /api/tools","title":"Create Tool","href":"/api-reference/tools/tools-post"},{"openapi":"put /api/tools/{tool_id}","title":"Update Tool","href":"/api-reference/tools/tools-put"},{"openapi":"delete /api/tools/{tool_id}","title":"Delete Tool","href":"/api-reference/tools/tools-delete"},{"openapi":"get /api/tools/{tool_id}/history","title":"Get Tool History","href":"/api-reference/tools/tools-history-get"},{"openapi":"post /api/tools/{tool_id}/test","title":"Test Tool","href":"/api-reference/tools/tools-test-post"}]},{"group":"Triggers","pages":[{"openapi":"get /api/triggers","title":"List Triggers","href":"/api-reference/triggers/triggers-list"},{"openapi":"get /api/triggers/{trigger_id}","title":"Get Trigger","href":"/api-reference/triggers/triggers-get"},{"openapi":"post /api/triggers","title":"Create Trigger","href":"/api-reference/triggers/triggers-post"},{"openapi":"put /api/triggers/{trigger_id}","title":"Update Trigger","href":"/api-reference/triggers/triggers-put"},{"openapi":"delete /api/triggers/{trigger_id}","title":"Delete Trigger","href":"/api-reference/triggers/triggers-delete"}]},{"group":"Voices","pages":[{"openapi":"get /api/voices","title":"List Voices","href":"/api-reference/voices/voices-list"},{"openapi":"get /api/voices/{voice_id}","title":"Get Voice","description":"Gets details for the specified voice","href":"/api-reference/voices/voices-get"},{"openapi":"post /api/voices","title":"Create (Clone) Voice","playground":"none","href":"/api-reference/voices/voices-post"},{"openapi":"delete /api/voices/{voice_id}","title":"Delete Voice","description":"Deletes the specified voice","href":"/api-reference/voices/voices-delete"},{"openapi":"put /api/voices/{voice_id}","title":"Replace Voice","href":"/api-reference/voices/voices-put"},{"openapi":"patch /api/voices/{voice_id}","title":"Update Voice","href":"/api-reference/voices/voices-patch"},{"openapi":"post /api/voice_preview","title":"Preview Voice","href":"/api-reference/voices/voice-preview-post"},{"openapi":"get /api/voices/{voice_id}/preview","title":"Get Voice Sample","href":"/api-reference/voices/voices-preview-get"}]},{"group":"Webhooks","pages":[{"openapi":"get /api/webhooks","title":"List Webhooks","href":"/api-reference/webhooks/webhooks-list"},{"openapi":"get /api/webhooks/{webhook_id}","title":"Get Webhook","href":"/api-reference/webhooks/webhooks-get"},{"openapi":"post /api/webhooks","title":"Create Webhook","href":"/api-reference/webhooks/webhooks-post"},{"openapi":"put /api/webhooks/{webhook_id}","title":"Replace Webhook","href":"/api-reference/webhooks/webhooks-put"},{"openapi":"patch /api/webhooks/{webhook_id}","title":"Update Webhook","href":"/api-reference/webhooks/webhooks-patch"},{"openapi":"delete /api/webhooks/{webhook_id}","title":"Delete Webhook","href":"/api-reference/webhooks/webhooks-delete"}]},{"group":"Telephony","pages":[{"openapi":"get /api/sip","title":"Get Account SIP configuration","href":"/api-reference/sip/sip-get"},{"openapi":"patch /api/sip","title":"Update Account SIP configuration","href":"/api-reference/sip/sip-partial-update"},{"openapi":"post /api/sip/registrations","title":"Create SIP Registration","href":"/api-reference/sip/sip-registrations-create"},{"openapi":"get /api/sip/registrations","title":"List SIP Registrations","href":"/api-reference/sip/sip-registrations-list"},{"openapi":"get /api/sip/registrations/{registration_id}","title":"Get SIP Registration","href":"/api-reference/sip/sip-registrations-get"},{"openapi":"patch /api/sip/registrations/{registration_id}","title":"Update SIP Registration","href":"/api-reference/sip/sip-registrations-partial-update"},{"openapi":"delete /api/sip/registrations/{registration_id}","title":"Delete SIP Registration","href":"/api-reference/sip/sip-registrations-delete"},{"openapi":"get /api/telephony_configs/twilio","title":"Get Twilio Configuration for Account","href":"/api-reference/telephony/twilio-get"},{"openapi":"post /api/telephony_configs/twilio","title":"Create Twilio Configuration for Account","href":"/api-reference/telephony/twilio-post"},{"openapi":"patch /api/telephony_configs/twilio","title":"Update Twilio Configuration for Account","href":"/api-reference/telephony/twilio-patch"},{"openapi":"delete /api/telephony_configs/twilio","title":"Delete Twilio Configuration for Account","href":"/api-reference/telephony/twilio-delete"},{"openapi":"get /api/telephony_configs/telnyx","title":"Get Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-get"},{"openapi":"post /api/telephony_configs/telnyx","title":"Create Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-post"},{"openapi":"patch /api/telephony_configs/telnyx","title":"Update Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-patch"},{"openapi":"delete /api/telephony_configs/telnyx","title":"Delete Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-delete"},{"openapi":"get /api/telephony_configs/plivo","title":"Get Plivo Configuration for Account","href":"/api-reference/telephony/plivo-get"},{"openapi":"post /api/telephony_configs/plivo","title":"Create Plivo Configuration for Account","href":"/api-reference/telephony/plivo-post"},{"openapi":"patch /api/telephony_configs/plivo","title":"Update Plivo Configuration for Account","href":"/api-reference/telephony/plivo-patch"},{"openapi":"delete /api/telephony_configs/plivo","title":"Delete Plivo Configuration for Account","href":"/api-reference/telephony/plivo-delete"},{"openapi":"patch /api/accounts/me/telephony_config","title":"Set Telephony Credentials","href":"/api-reference/accounts/accounts-me-telephony-config-partial-update"},{"openapi":"get /api/accounts/me/telephony_config","title":"Get Telephony Credentials","href":"/api-reference/accounts/accounts-me-telephony-config-retrieve"}]},{"group":"Schema","pages":[{"title":"Call Definition","href":"/api-reference/schema/call-definition"},{"title":"Base Tool Definition","href":"/api-reference/schema/base-tool-definition"},{"title":"SIP Fallback Handler Response","href":"/api-reference/schema/sip-fallback-handler-response"},{"title":"Ultravox Data Message Protocol","href":"/api-reference/schema/datamessages"}]},{"group":"Other","pages":[{"openapi":"get /api/models","title":"List Models","href":"/api-reference/other/models-get"},{"openapi":"get /api/schema/","title":"Get OpenAPI Schema","href":"/api-reference/other/schema-get"}]}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/voximplant"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/news"}]}]},"basePath":"","title":"Create (Clone) Voice - Ultravox Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}