Skip to main content
PATCH
cURL
Allows partial modifications to the voice.

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

voice_id
string<uuid>
required

Body

application/json
name
string
Maximum string length: 40
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
definition
object

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.

Response

200 - 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.

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