GET
/
api
/
voices
/
{voice_id}
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/voices/{voice_id} \
  --header 'X-API-Key: <api-key>'
{
  "voiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "primaryLanguage": "<string>",
  "previewUrl": "<string>",
  "ownership": "public",
  "billingStyle": "VOICE_BILLING_STYLE_INCLUDED",
  "provider": "<string>",
  "definition": {
    "elevenLabs": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "useSpeakerBoost": true,
      "style": 123,
      "similarityBoost": 123,
      "stability": 123,
      "pronunciationDictionaries": [
        {
          "dictionaryId": "<string>",
          "versionId": "<string>"
        }
      ],
      "optimizeStreamingLatency": 123,
      "maxSampleRate": 123
    },
    "cartesia": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "emotion": "<string>",
      "emotions": [
        "<string>"
      ]
    },
    "lmnt": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "conversational": true
    },
    "google": {
      "voiceId": "<string>",
      "speakingRate": 123
    },
    "generic": {
      "url": "<string>",
      "headers": {},
      "body": {},
      "responseSampleRate": 123,
      "responseWordsPerMinute": 123,
      "responseMimeType": "<string>",
      "jsonAudioFieldPath": "<string>"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
voice_id
string<uuid>
required

Response

200 - application/json
​
voiceId
string<uuid>
required
​
name
string
required
Maximum length: 40
​
previewUrl
string<uri>
required
​
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
​
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.

​
description
string | null
Maximum length: 240
​
primaryLanguage
string | null

BCP47 language code for the primary language supported by this voice.

Maximum length: 10