Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.
Path Parameters
id
string
required
Pattern: ^[0-9a-f]{24}$
Example:
"6a96a3ead6e886d42462dd3e"
Response
The voice
id
string
required
Pattern: ^[0-9a-f]{24}$
Example:
"6a96a3ead6e886d42462dd3e"
object
enum<string>
required
Available options:
voice
name
string
required
description
string | null
required
provider
enum<string>
required
Where the clone is made, which decides the engines it speaks on. elevenlabs for the classic and deepgram_agent engines; sarvam for the sarvam engine, which is the one to use for Indian languages.
Available options:
elevenlabs,
sarvam
provider_voice_id
string
required
Put this in an agent’s tts.voice to make it speak in this voice.
Example:
"c38kUX8pkfYO2kHyqfFy"
engines
string[]
required
The engines that can speak in this voice.
Example:
["classic", "deepgram_agent"]
language
string | null
required
The language of the recording. Sarvam clones can still speak every language Sarvam supports.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Wixzel Voice","colors":{"primary":"#A0D425","light":"#B4E63F","dark":"#A0D425"},"logo":{"light":"https://mintcdn.com/wixzel/HwQTLjpYLGrNSo5e/logo/light.png?fit=max\u0026auto=format\u0026n=HwQTLjpYLGrNSo5e\u0026q=85\u0026s=f77486fb54c4d73acde1ed87b534af5d","dark":"https://mintcdn.com/wixzel/HF4ObqENc3iamXvz/logo/dark.png?fit=max\u0026auto=format\u0026n=HF4ObqENc3iamXvz\u0026q=85\u0026s=9d6e569aacc29f07bf16f1e63276ff9a","href":"https://voice.wixzel.com"},"favicon":"https://mintcdn.com/wixzel/tEejfXfPmKt3Fqur/favicon.ico?fit=max\u0026auto=format\u0026n=tEejfXfPmKt3Fqur\u0026q=85\u0026s=b1931601394f0a112b235257d2e6bb27","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.voice.wixzel.com"}},"appearance":{"default":"dark"},"background":{"color":{"dark":"#0D0D0D"}},"navbar":{"links":[{"href":"https://voice.wixzel.com/pricing","label":"Pricing"},{"href":"https://voice.wixzel.com/guides","label":"Guides"}],"primary":{"type":"button","label":"Get an API key","href":"https://voice.wixzel.com/signup"}},"footer":{"socials":{"website":"https://voice.wixzel.com","github":"https://github.com/aqeelshamz/wixzel-voice-sdks"},"links":[{"header":"Wixzel Voice","items":[{"label":"Facts","href":"https://voice.wixzel.com/facts"},{"label":"Pricing","href":"https://voice.wixzel.com/pricing"},{"label":"Solutions","href":"https://voice.wixzel.com/solutions"},{"label":"Integrations","href":"https://voice.wixzel.com/carriers"},{"label":"Guides","href":"https://voice.wixzel.com/guides"}]}]},"seo":{"metatags":{"og:site_name":"Wixzel Voice","og:image":"https://voice.wixzel.com/opengraph-image"},"organization":{"id":"https://voice.wixzel.com/#organization","name":"Wixzel Voice","legalName":"Aqeel Shamsudheen, trading as Wixzel","url":"https://voice.wixzel.com","logo":"https://voice.wixzel.com/icon-512.png","sameAs":["https://github.com/aqeelshamz/wixzel-voice-sdks","https://www.npmjs.com/package/wixzel-voice","https://www.npmjs.com/package/wixzel-voice-mcp","https://pub.dev/packages/wixzel_voice","https://pub.dev/packages/wixzel_voice_flutter","https://wixzel.com/products/wixzel-voice"]}},"fonts":{"heading":{"family":"Sora"},"body":{"family":"Plus Jakarta Sans"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wixzel","hasAudioNarration":false,"actualSubdomain":"wixzel","customDomains":["docs.voice.wixzel.com"],"gitSource":{"type":"github","owner":"aqeelshamz","repo":"wixzel-voice","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af5d7d504140d5ce9d70649","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":124},{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"WhatsApp","count":15},{"language":"default","tag":"Knowledge bases","count":11},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Carriers","count":8},{"language":"default","tag":"Calls","count":8},{"language":"default","tag":"Phone numbers","count":8},{"language":"default","tag":"SIP trunks","count":8},{"language":"default","tag":"Concepts","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":true},"customCss":[]}
{"page":{"pagePath":"api-reference/voices/retrieve-a-voice","slug":"/api-reference/voices/retrieve-a-voice","pageMetadata":{"title":"Retrieve a voice","description":"Requires `voices:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{id}","href":"/api-reference/voices/retrieve-a-voice","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Requires \", _jsx(_components.code, {\n children: \"voices:read\"\n }), \".\"]\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":"Retrieve a voice","description":"Requires `voices:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{id}","href":"/api-reference/voices/retrieve-a-voice","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Voices"],"security":["9d8f343d-fa2e-45c0-a1ae-bedb19cac588"],"summary":"Retrieve a voice","description":"Requires `voices:read`.","parameters":["55a7a5f9-637f-4358-b51c-484b295c242a"],"responses":{"200":"8fe845d1-112d-48cd-b71d-31559e5e8b08","400":"c6978e05-d61c-4452-8d1a-49c40650a14e","401":"0ffb2112-7825-41ec-aa1e-f5a34514a63f","403":"d970393d-2f1b-4267-9e1e-1fbd59864b5d","404":"dba4805d-9e05-4aa2-ae7c-d2da8f33a90a","429":"7fb2a441-3532-4225-a246-b39e17306a39"},"method":"get","type":"path","servers":["33cae336-1b94-4309-8f36-689b1dc831ab"],"path":"/v1/voices/{id}","baseUrlOptions":["https://api.voice.wixzel.com"],"title":"Retrieve a voice","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"55a7a5f9-637f-4358-b51c-484b295c242a":{"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"id","in":"path"}},"responses":{"8fe845d1-112d-48cd-b71d-31559e5e8b08":{"description":"The voice","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["voice"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"provider":{"type":"string","enum":["elevenlabs","sarvam"],"description":"Where the clone is made, which decides the engines it speaks on. `elevenlabs` for the `classic` and `deepgram_agent` engines; `sarvam` for the `sarvam` engine, which is the one to use for Indian languages.","isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"provider_voice_id":{"type":"string","description":"Put this in an agent’s `tts.voice` to make it speak in this voice.","example":"c38kUX8pkfYO2kHyqfFy","isRequired":true,"uniqueKey":"provider_voice_id","typeLabel":"string"},"engines":{"type":"array","items":{"type":"string","uniqueKey":"engines.items.[INDEX]","typeLabel":"string"},"description":"The engines that can speak in this voice.","example":["classic","deepgram_agent"],"isRequired":true,"uniqueKey":"engines","typeLabel":"string[]"},"language":{"oneOf":[{"type":"string","description":"The language of the recording. Sarvam clones can still speak every language Sarvam supports.","isRequired":true,"uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","description":"The language of the recording. Sarvam clones can still speak every language Sarvam supports.","isRequired":true,"uniqueKey":"language.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"language","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601, always UTC.","example":"2026-09-01T12:00:00.000Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601, always UTC.","example":"2026-09-01T12:00:00.000Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","object","name","description","provider","provider_voice_id","engines","language","created_at","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"6a96a3ead6e886d42462dd3e","object":"voice","name":"\u003cstring>","description":"\u003cstring>","provider":"elevenlabs","provider_voice_id":"c38kUX8pkfYO2kHyqfFy","engines":["classic","deepgram_agent"],"language":"\u003cstring>","created_at":"2026-09-01T12:00:00.000Z","updated_at":"2026-09-01T12:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"c6978e05-d61c-4452-8d1a-49c40650a14e":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0ffb2112-7825-41ec-aa1e-f5a34514a63f":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d970393d-2f1b-4267-9e1e-1fbd59864b5d":{"description":"Key lacks the required scope","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"dba4805d-9e05-4aa2-ae7c-d2da8f33a90a":{"description":"No such record","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7fb2a441-3532-4225-a246-b39e17306a39":{"description":"Rate limited. Retry after the interval in `Retry-After`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9d8f343d-fa2e-45c0-a1ae-bedb19cac588":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your Wixzel Voice API key: `Authorization: Bearer wv_live_...`. Keys are scoped; grant only what the integration needs.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"33cae336-1b94-4309-8f36-689b1dc831ab":{"url":"https://api.voice.wixzel.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your Wixzel Voice API key: `Authorization: Bearer wv_live_...`. Keys are scoped; grant only what the integration needs.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Wixzel Voice API key: `Authorization: Bearer wv_live_...`. Keys are scoped; grant only what the integration needs.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"wixzel","siteName":"Wixzel Voice","title":"Retrieve a voice - Wixzel Voice","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T15:14:36.584Z","originalFileLocation":"api-reference/voices/retrieve-a-voice.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=\"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=\"Requires voices:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wixzel Voice\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a voice - Wixzel Voice\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires voices:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wixzel Voice\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://voice.wixzel.com/opengraph-image\">\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=\"Retrieve a voice - Wixzel Voice\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires voices:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://voice.wixzel.com/opengraph-image\">\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/wixzel/UnboSZUle7evZMp7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wixzel Voice\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A0D425\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-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/voices/retrieve-a-voice.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://voice.wixzel.com/#organization\",\"name\":\"Wixzel Voice\",\"legalName\":\"Aqeel Shamsudheen, trading as Wixzel\",\"url\":\"https://voice.wixzel.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://voice.wixzel.com/icon-512.png\"},\"sameAs\":[\"https://github.com/aqeelshamz/wixzel-voice-sdks\",\"https://www.npmjs.com/package/wixzel-voice\",\"https://www.npmjs.com/package/wixzel-voice-mcp\",\"https://pub.dev/packages/wixzel_voice\",\"https://pub.dev/packages/wixzel_voice_flutter\",\"https://wixzel.com/products/wixzel-voice\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voice.wixzel.com#website\",\"name\":\"Wixzel Voice\",\"url\":\"https://docs.voice.wixzel.com\",\"publisher\":{\"@id\":\"https://voice.wixzel.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice#webpage\",\"url\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice\",\"name\":\"Retrieve a voice\",\"description\":\"Requires voices:read.\",\"dateModified\":\"2026-11-12T15:14:36.584Z\",\"isPartOf\":{\"@id\":\"https://docs.voice.wixzel.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.voice.wixzel.com/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Voices\",\"item\":\"https://docs.voice.wixzel.com/api-reference/voices/list-voices\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a voice\",\"item\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice#apireference\",\"headline\":\"Retrieve a voice\",\"name\":\"Retrieve a voice\",\"description\":\"Requires voices:read.\",\"url\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voice.wixzel.com/api-reference/voices/retrieve-a-voice#webpage\"},\"image\":\"https://voice.wixzel.com/opengraph-image\",\"dateModified\":\"2026-11-12T15:14:36.584Z\",\"publisher\":{\"@id\":\"https://voice.wixzel.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voice.wixzel.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wixzel Voice\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Wixzel Voice\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/voices/retrieve-a-voice.md","siteName":"Wixzel Voice","nav":{"global":null,"groups":[{"group":"Getting started","pages":[{"title":"Wixzel Voice documentation: API, SDKs and MCP server","sidebarTitle":"Overview","href":"/index"},{"title":"Get started with Wixzel Voice: account, key, credit and trunk","sidebarTitle":"Get started","href":"/get-started"},{"title":"Quickstart: place your first AI voice agent phone call with the API","sidebarTitle":"Quickstart","href":"/quickstart"}]},{"group":"Guides","pages":[{"title":"Build an AI voice agent with the API: prompt, voice and call handling","sidebarTitle":"Agents","href":"/agents"},{"title":"Give your voice agent a face: the agent's mascot","sidebarTitle":"Mascots","href":"/mascots"},{"title":"Callers: who called your agent, and blocking them","sidebarTitle":"Callers","href":"/callers"},{"title":"Give your AI phone agent a knowledge base","sidebarTitle":"Knowledge bases","href":"/knowledge-bases"},{"title":"Give your AI phone agent tools: webhooks and app actions","sidebarTitle":"Tools","href":"/tools"},{"title":"Clone a voice for your AI phone agent","sidebarTitle":"Voice cloning","href":"/voice-cloning"},{"title":"Put your AI agent on WhatsApp","sidebarTitle":"WhatsApp","href":"/whatsapp"},{"title":"Wixzel Voice API keys: scopes, rotation and revocation","sidebarTitle":"API keys","href":"/api-keys"},{"title":"Prepaid credits: what an AI phone call costs, billed per second","sidebarTitle":"Credits","href":"/credits"},{"title":"SIP trunks: connect any carrier to Wixzel Voice","sidebarTitle":"SIP trunks","href":"/sip-trunks"},{"title":"Wixzel Voice SDKs for TypeScript and Dart (Flutter)","sidebarTitle":"SDKs","href":"/sdks"},{"title":"Call the Wixzel Voice API from cURL, Node.js and Python","sidebarTitle":"Integrate","href":"/integrate"},{"title":"Wixzel Voice MCP server: connect Claude Code, Codex, Cursor or any MCP client","sidebarTitle":"MCP server","href":"/mcp-server"},{"title":"Let a voice agent use other apps' MCP servers during a call","sidebarTitle":"MCP integrations","href":"/mcp-integrations"},{"title":"Webhooks for AI phone calls: signed events and a delivery log","sidebarTitle":"Webhooks","href":"/webhooks"},{"title":"Realtime API: connect a web or Flutter app to an agent over WebSocket","sidebarTitle":"Realtime: web and mobile","href":"/realtime"},{"title":"Meetings: send an AI voice agent into Zoom, Google Meet or Teams","sidebarTitle":"Meetings","href":"/meetings"},{"title":"Compose a voice AI pipeline: speech-to-text, LLM and text-to-speech","sidebarTitle":"Compose a voice engine","href":"/composing"},{"title":"Self-host Wixzel Voice on your own server","sidebarTitle":"Self-hosting","href":"/self-hosting"}]},{"group":"Carriers","pages":[{"title":"Twilio Elastic SIP Trunking: console steps for Wixzel Voice","sidebarTitle":"Twilio","href":"/carriers/twilio"},{"title":"Telnyx SIP Connection: console steps for Wixzel Voice","sidebarTitle":"Telnyx","href":"/carriers/telnyx"},{"title":"Plivo Zentrunk: console steps for Wixzel Voice","sidebarTitle":"Plivo","href":"/carriers/plivo"},{"title":"Vonage Programmable SIP: console steps for Wixzel Voice","sidebarTitle":"Vonage","href":"/carriers/vonage"},{"title":"Bandwidth SIP trunk: console steps for Wixzel Voice","sidebarTitle":"Bandwidth","href":"/carriers/bandwidth"},{"title":"Exotel vSIP trunk: console steps for Wixzel Voice","sidebarTitle":"Exotel","href":"/carriers/exotel"},{"title":"Vobiz SIP trunk: console steps for Wixzel Voice","sidebarTitle":"Vobiz","href":"/carriers/vobiz"},{"title":"Mobily SIP trunk: setup for Wixzel Voice","sidebarTitle":"Mobily","href":"/carriers/mobily"}]},{"group":"Concepts","pages":[{"title":"Voice engines: STT, LLM and TTS pipelines or one realtime model","sidebarTitle":"Voice engines","href":"/voice-engines"},{"title":"Wixzel Voice billing: per-second metering, itemised usage","sidebarTitle":"Billing","href":"/billing"},{"title":"Authenticate to the Wixzel Voice API with scoped bearer keys","sidebarTitle":"Authentication","href":"/authentication"},{"title":"Wixzel Voice API errors: types, codes and request ids","sidebarTitle":"Errors","href":"/errors"},{"title":"Pagination: walking list endpoints with cursors","sidebarTitle":"Pagination","href":"/pagination"},{"title":"Idempotency keys: retry an AI phone call without paying twice","sidebarTitle":"Idempotency","href":"/idempotency"},{"title":"Wixzel Voice rate limits and concurrent call limits","sidebarTitle":"Rate limits","href":"/rate-limits"}]},{"group":"API reference","pages":[{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"Retrieve an agent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents/{id}","href":"/api-reference/agents/retrieve-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agents/{id}","href":"/api-reference/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agents/{id}","href":"/api-reference/agents/update-an-agent"},{"title":"Place a test call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/test-call","href":"/api-reference/agents/place-a-test-call"},{"title":"Generate an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/generate","href":"/api-reference/agents/generate-an-agent"},{"title":"Update an agent's mascot","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agents/{id}/mascot","href":"/api-reference/agents/update-an-agents-mascot"},{"title":"Generate a new mascot look","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/mascot/generate","href":"/api-reference/agents/generate-a-new-mascot-look"},{"title":"Change a mascot's share id","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/mascot/rotate-public-id","href":"/api-reference/agents/change-a-mascots-share-id"}]},{"group":"Realtime","pages":[{"title":"Create a realtime session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/realtime/sessions","href":"/api-reference/realtime/create-a-realtime-session"}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/leads","href":"/api-reference/leads/list-leads"},{"title":"Create a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/leads","href":"/api-reference/leads/create-a-lead"},{"title":"Retrieve a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/leads/{id}","href":"/api-reference/leads/retrieve-a-lead"},{"title":"Delete a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/leads/{id}","href":"/api-reference/leads/delete-a-lead"},{"title":"Update a lead","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/leads/{id}","href":"/api-reference/leads/update-a-lead"},{"title":"Import many leads","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/leads/bulk","href":"/api-reference/leads/import-many-leads"}]},{"group":"Campaigns","pages":[{"title":"Start a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns/{id}/start","href":"/api-reference/campaigns/start-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns/{id}/pause","href":"/api-reference/campaigns/pause-a-campaign"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Retrieve a campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/campaigns/{id}","href":"/api-reference/campaigns/retrieve-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/campaigns/{id}","href":"/api-reference/campaigns/delete-a-campaign"}]},{"group":"Knowledge bases","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases","href":"/api-reference/knowledge-bases/create-a-knowledge-base"},{"title":"Retrieve a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/retrieve-a-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/delete-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/update-a-knowledge-base"},{"title":"Draft a knowledge base from a website","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases/import","href":"/api-reference/knowledge-bases/draft-a-knowledge-base-from-a-website"},{"title":"Draft a knowledge base from a file","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases/import-file","href":"/api-reference/knowledge-bases/draft-a-knowledge-base-from-a-file"},{"title":"List a knowledge base’s files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases/{id}/files","href":"/api-reference/knowledge-bases/list-a-knowledge-base’s-files"},{"title":"Add files to a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases/{id}/files","href":"/api-reference/knowledge-bases/add-files-to-a-knowledge-base"},{"title":"Retrieve a knowledge base file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases/{id}/files/{fileId}","href":"/api-reference/knowledge-bases/retrieve-a-knowledge-base-file"},{"title":"Remove a knowledge base file","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge-bases/{id}/files/{fileId}","href":"/api-reference/knowledge-bases/remove-a-knowledge-base-file"}]},{"group":"Phone numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Create a phone number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/phone-numbers","href":"/api-reference/phone-numbers/create-a-phone-number"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/retrieve-a-phone-number"},{"title":"Delete a phone number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/delete-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/update-a-phone-number"},{"title":"List the numbers on a carrier account","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/carrier-numbers","href":"/api-reference/phone-numbers/list-the-numbers-on-a-carrier-account"},{"title":"Search for numbers to buy","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/available-numbers","href":"/api-reference/phone-numbers/search-for-numbers-to-buy"},{"title":"Buy a number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/phone-numbers/purchase","href":"/api-reference/phone-numbers/buy-a-number"}]},{"group":"SIP trunks","pages":[{"title":"List sip trunks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks","href":"/api-reference/sip-trunks/list-sip-trunks"},{"title":"Create a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sip-trunks","href":"/api-reference/sip-trunks/create-a-sip-trunk"},{"title":"Retrieve a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}","href":"/api-reference/sip-trunks/retrieve-a-sip-trunk"},{"title":"Delete a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sip-trunks/{id}","href":"/api-reference/sip-trunks/delete-a-sip-trunk"},{"title":"Update a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/sip-trunks/{id}","href":"/api-reference/sip-trunks/update-a-sip-trunk"},{"title":"Check a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/status","href":"/api-reference/sip-trunks/check-a-sip-trunk"},{"title":"Test a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sip-trunks/{id}/test","href":"/api-reference/sip-trunks/test-a-sip-trunk"},{"title":"Recent SIP events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/logs","href":"/api-reference/sip-trunks/recent-sip-events"}]},{"group":"MCP servers","pages":[{"title":"List mcp servers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/mcp-servers","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/mcp-servers","href":"/api-reference/mcp-servers/create-an-mcp-server"},{"title":"Retrieve an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/mcp-servers/{id}","href":"/api-reference/mcp-servers/retrieve-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/mcp-servers/{id}","href":"/api-reference/mcp-servers/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/mcp-servers/{id}","href":"/api-reference/mcp-servers/update-an-mcp-server"},{"title":"Refresh an MCP server’s tools","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/mcp-servers/{id}/refresh","href":"/api-reference/mcp-servers/refresh-an-mcp-server’s-tools"},{"title":"Connect an OAuth MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/mcp-servers/{id}/oauth/start","href":"/api-reference/mcp-servers/connect-an-oauth-mcp-server"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tools","href":"/api-reference/tools/list-tools"},{"title":"Create a tool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tools","href":"/api-reference/tools/create-a-tool"},{"title":"Retrieve a tool","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tools/{id}","href":"/api-reference/tools/retrieve-a-tool"},{"title":"Delete a tool","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/tools/{id}","href":"/api-reference/tools/delete-a-tool"},{"title":"Update a tool","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/tools/{id}","href":"/api-reference/tools/update-a-tool"},{"title":"Test a webhook tool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tools/{id}/test","href":"/api-reference/tools/test-a-webhook-tool"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices","href":"/api-reference/voices/list-voices"},{"title":"Clone a voice","description":"Makes a cloned voice from recordings of one person speaking, and charges the one-off fee in the price book (`voice_clone`). `consent` must be `true`. Send the recordings as `files` in a multipart request, or as `audio_urls` in JSON. The recordings are passed to the provider and not stored. Put the returned `provider_voice_id` in an agent’s `tts.voice`; only engines listed in `engines` can speak in it. Requires `voices:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voices","href":"/api-reference/voices/clone-a-voice"},{"title":"Retrieve a voice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{id}","href":"/api-reference/voices/retrieve-a-voice"},{"title":"Delete a voice","description":"Deletes the clone at the provider too. Refused with 409 `voice_in_use` while an agent speaks in it. The cloning fee is not refunded. Requires `voices:write`.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/voices/{id}","href":"/api-reference/voices/delete-a-voice"},{"title":"Update a voice","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/voices/{id}","href":"/api-reference/voices/update-a-voice"},{"title":"Preview a voice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{id}/preview","href":"/api-reference/voices/preview-a-voice"}]},{"group":"Appointments","pages":[{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/appointments","href":"/api-reference/appointments/list-appointments"},{"title":"Create an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/appointments","href":"/api-reference/appointments/create-an-appointment"},{"title":"Retrieve an appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/appointments/{id}","href":"/api-reference/appointments/retrieve-an-appointment"},{"title":"Delete an appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/appointments/{id}","href":"/api-reference/appointments/delete-an-appointment"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/appointments/{id}","href":"/api-reference/appointments/update-an-appointment"}]},{"group":"Callers","pages":[{"title":"List callers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/callers","href":"/api-reference/callers/list-callers"},{"title":"Retrieve a caller","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/callers/{id}","href":"/api-reference/callers/retrieve-a-caller"},{"title":"Block or unblock a caller","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/callers/{id}","href":"/api-reference/callers/block-or-unblock-a-caller"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Place a call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls","href":"/api-reference/calls/place-a-call"},{"title":"Retrieve a call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}","href":"/api-reference/calls/retrieve-a-call"},{"title":"Delete a call record","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/calls/{id}","href":"/api-reference/calls/delete-a-call-record"},{"title":"Retrieve a transcript","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}/transcript","href":"/api-reference/calls/retrieve-a-transcript"},{"title":"End a call in progress","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls/{id}/hangup","href":"/api-reference/calls/end-a-call-in-progress"},{"title":"Retrieve call settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/call-settings","href":"/api-reference/calls/retrieve-call-settings"},{"title":"Update call settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/call-settings","href":"/api-reference/calls/update-call-settings"}]},{"group":"Usage","pages":[{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/events","href":"/api-reference/usage/list-usage-events"},{"title":"Summarise usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/summary","href":"/api-reference/usage/summarise-usage"}]},{"group":"Billing","pages":[{"title":"Retrieve your balance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/balance","href":"/api-reference/billing/retrieve-your-balance"},{"title":"List ledger entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/ledger","href":"/api-reference/billing/list-ledger-entries"},{"title":"Add credit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/topups","href":"/api-reference/billing/add-credit"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Rotate an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys/{id}/rotate","href":"/api-reference/api-keys/rotate-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"Engines","pages":[{"title":"List available engines and models","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engines","href":"/api-reference/engines/list-available-engines-and-models"},{"title":"List an engine's languages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engines/{engine}/languages","href":"/api-reference/engines/list-an-engines-languages"},{"title":"List an engine's speaker voices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engines/{engine}/voices","href":"/api-reference/engines/list-an-engines-speaker-voices"}]},{"group":"Webhooks","pages":[{"title":"Retrieve the webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook","href":"/api-reference/webhooks/retrieve-the-webhook-endpoint"},{"title":"Update the webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/webhook","href":"/api-reference/webhooks/update-the-webhook-endpoint"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List delivery attempts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook/deliveries","href":"/api-reference/webhooks/list-delivery-attempts"}]},{"group":"WhatsApp","pages":[{"title":"List WhatsApp numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/accounts","href":"/api-reference/whatsapp/list-whatsapp-numbers"},{"title":"Connect a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/accounts","href":"/api-reference/whatsapp/connect-a-whatsapp-number"},{"title":"Retrieve a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/accounts/{id}","href":"/api-reference/whatsapp/retrieve-a-whatsapp-number"},{"title":"Disconnect a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/accounts/{id}","href":"/api-reference/whatsapp/disconnect-a-whatsapp-number"},{"title":"Update a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/whatsapp/accounts/{id}","href":"/api-reference/whatsapp/update-a-whatsapp-number"},{"title":"Refresh a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/accounts/{id}/refresh","href":"/api-reference/whatsapp/refresh-a-whatsapp-number"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/templates","href":"/api-reference/whatsapp/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates","href":"/api-reference/whatsapp/create-a-message-template"},{"title":"Sync message templates","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates/sync","href":"/api-reference/whatsapp/sync-message-templates"},{"title":"Delete a message template","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/templates/{id}","href":"/api-reference/whatsapp/delete-a-message-template"},{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/messages","href":"/api-reference/whatsapp/send-a-whatsapp-message"},{"title":"List WhatsApp conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/conversations","href":"/api-reference/whatsapp/list-whatsapp-conversations"},{"title":"Retrieve a WhatsApp conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/conversations/{id}","href":"/api-reference/whatsapp/retrieve-a-whatsapp-conversation"},{"title":"List scheduled WhatsApp messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/scheduled-messages","href":"/api-reference/whatsapp/list-scheduled-whatsapp-messages"},{"title":"Cancel a scheduled WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/scheduled-messages/{id}","href":"/api-reference/whatsapp/cancel-a-scheduled-whatsapp-message"}]},{"group":"Meetings","pages":[{"title":"Retrieve the meeting integration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/meetings/integration","href":"/api-reference/meetings/retrieve-the-meeting-integration"},{"title":"Connect Attendee","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/meetings/integration","href":"/api-reference/meetings/connect-attendee"},{"title":"Disconnect Attendee","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/meetings/integration","href":"/api-reference/meetings/disconnect-attendee"},{"title":"List meetings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/meetings","href":"/api-reference/meetings/list-meetings"},{"title":"Send an agent to a meeting","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/meetings","href":"/api-reference/meetings/send-an-agent-to-a-meeting"},{"title":"Retrieve a meeting","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/meetings/{id}","href":"/api-reference/meetings/retrieve-a-meeting"},{"title":"Leave a meeting","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/meetings/{id}/leave","href":"/api-reference/meetings/leave-a-meeting"}]}]}]},"basePath":"","title":"Retrieve a voice - Wixzel Voice","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"]}