latestOpenAPI 3.1.02026-08-206635377.2 KB

dae97e8eb063

Voices

update voice

Update a voice by ID (display name and provider model ID can be updated)

put/v1/voices/{id}

Path parameters

idstring uuid required

Voice ID

Request body

displayNamestring required

New display name for the voice

providerModelIdstring

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

gender'MALE' | 'FEMALE' | 'NEUTRAL' | 'null' nullable

Voice gender

countrystring nullable

ISO 3166-1 alpha-2 country code

descriptionstring nullable

Voice description

Example request

{
  "providerModelId": "sonic-3.5"
}

Response

Successfully updated voice

idstring uuid

Unique identifier for the voice.

displayNamestring

Human-readable name shown in the Lab.

provider'CARTESIA' | 'ELEVENLABS' | 'OPENAI_ADVANCED_VOICE' | 'FISH_AUDIO'

Upstream TTS provider for this voice.

providerVoiceIdstring nullable

The upstream provider's identifier for the voice.

providerModelIdstring nullable

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

sampleUrlstring uri nullable

URL of a short audio preview of the voice.

previewSampleUrlstring uri nullable

Alias for sampleUrl, kept for backwards compatibility.

gender'MALE' | 'FEMALE' | 'NEUTRAL' | 'null' nullable

Perceived gender of the voice, if categorised.

countrystring nullable

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

descriptionstring nullable

Free-form description of the voice's character.

displayTagsstring[]

Tags used to categorise the voice in the Lab UI.

isZdrboolean

Whether this voice meets the Zero Data Retention requirements.

createdByOrganizationIdstring nullable

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.

createdAtstring date-time

Timestamp when the voice was created.

updatedAtstring date-time

Timestamp when the voice was last updated.