Skip to main content
PUT
update voice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Voice ID

Body

application/json

Fields to update on the voice. Only the listed fields can be changed; omit a field to leave it unchanged.

displayName
string
required

New display name for the voice

providerModelId
string

New provider model ID for the voice (e.g. sonic-3.5 for Cartesia, eleven_flash_v2_5 for ElevenLabs)

Example:

"sonic-3.5"

gender
enum<string> | null

Voice gender

Available options:
MALE,
FEMALE,
NEUTRAL,
null
country
string | null

ISO 3166-1 alpha-2 country code

description
string | null

Voice description

Response

Successfully updated voice

A voice preset a persona can use for text-to-speech.

id
string<uuid>

Unique identifier for the voice.

displayName
string

Human-readable name shown in the Lab.

provider
enum<string>

Upstream TTS provider for this voice.

Available options:
CARTESIA,
ELEVENLABS,
OPENAI_ADVANCED_VOICE,
FISH_AUDIO
providerVoiceId
string | null

The upstream provider's identifier for the voice.

providerModelId
string | null

The upstream provider's model identifier used to generate speech.

sampleUrl
string<uri> | null

URL of a short audio preview of the voice.

previewSampleUrl
string<uri> | null

Alias for sampleUrl, kept for backwards compatibility.

gender
enum<string> | null

Perceived gender of the voice, if categorised.

Available options:
MALE,
FEMALE,
NEUTRAL,
null
country
string | null

ISO 3166-1 alpha-2 country code representing the voice's accent.

description
string | null

Free-form description of the voice's character.

displayTags
string[]

Tags used to categorise the voice in the Lab UI.

isZdr
boolean

Whether this voice meets the Zero Data Retention requirements.

createdByOrganizationId
string | null

ID of the organization that created the voice, or null for stock voices. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.

createdAt
string<date-time>

Timestamp when the voice was created.

updatedAt
string<date-time>

Timestamp when the voice was last updated.

Last modified on July 10, 2026