Skip to content
Get started

Voices

Get voices
voices.list() -> VoiceListResponse { voices }
GET/voices
Get voice by ID
voices.retrieve(id, **kwargs) -> VoiceRetrieveResponse { voice }
GET/voices/{id}
Delete a voice
voices.delete(id) -> VoiceDeleteResponse { success }
DELETE/voices/{id}
Generate voice preview
voices.preview(**kwargs) -> void
POST/voices/preview
Clone a voice
voices.clone_(**kwargs) -> VoiceCloneResponse { id, cartesia_voice_id, created_at, 2 more }
POST/voices/clone
ModelsExpand Collapse
class VoiceListResponse { voices }
voices: Array[Voice{ id, description, language, 6 more}]
id: String

The ID of the voice.

minLength1
description: String

The description of the voice.

language: :en | :fr | :es | 5 more

The language of the voice.

One of the following:
:en
:fr
:es
:de
:it
:pt
:ru
:zh
name: String

The name of the voice.

provider: :cartesia | :elevenlabs | :gradium

The provider of the voice.

One of the following:
:cartesia
:elevenlabs
:gradium
accent: String

The accent/dialect of the voice (e.g. ‘american’, ‘british’, ‘australian’, ‘quebec’).

gender: String

The gender of the voice (e.g. ‘male’, ‘female’, ‘neutral’).

is_cloned: bool

Whether this is a cloned voice.

model_compat: :universal | :"sonic-3" | :"sonic-3.5" | :"sonic-3.6"

Cartesia model compatibility. Used to filter the voice list by the selected model. Absent/undefined is treated as ‘universal’.

One of the following:
:universal
:"sonic-3"
:"sonic-3.5"
:"sonic-3.6"
class VoiceRetrieveResponse { voice }
voice: Voice{ id, name, description}
id: String
name: String
description: String
class VoiceDeleteResponse { success }
success: bool
class VoiceCloneResponse { id, cartesia_voice_id, created_at, 2 more }
id: String
cartesia_voice_id: String
created_at: String
language: String
name: String