Skip to main content
GET
/
api
/
voices
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/voices \
  --header 'X-API-Key: <api-key>'
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "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>"
          ],
          "generationConfig": {
            "volume": 123,
            "speed": 123,
            "emotion": "<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>",
          "jsonByteEncoding": "JSON_BYTE_ENCODING_UNSPECIFIED"
        }
      }
    }
  ],
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Query Parameters

​
billingStyle
enum<string>

The billing style used to filter results.

  • VOICE_BILLING_STYLE_INCLUDED - Voices with no additional charges beyond the cost of the call
  • VOICE_BILLING_STYLE_EXTERNAL - Voices with costs billed directly by the TTS provider
Available options:
VOICE_BILLING_STYLE_INCLUDED,
VOICE_BILLING_STYLE_EXTERNAL
​
cursor
string

The pagination cursor value.

​
ownership
enum<string>

The ownership used to filter results.

  • private - Only private voices
  • public - Only public voices
Available options:
private,
public
​
pageSize
integer

Number of results to return per page.

​
primaryLanguage
string

The desired primary language for voice results using BCP47. Voices with different regions/scripts/variants but the same language tag may also be included but will be further down the results. If not provided, all languages are included.

Minimum length: 1
​
provider
enum<string>[]

The providers used to filter results.

​
search
string

The search string used to filter results.

Minimum length: 1

Response

200 - application/json
​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"

​
total
integer
Example:

123