Skip to content
RevoxRevox
Get started
API Reference

Voices

Get voices
client.voices.list(RequestOptionsoptions?): VoiceListResponse { voices }
GET/voices
Get voice by ID
client.voices.retrieve(stringid, VoiceRetrieveParams { provider } query, RequestOptionsoptions?): VoiceRetrieveResponse { voice }
GET/voices/{id}
Delete a voice
client.voices.delete(stringid, RequestOptionsoptions?): VoiceDeleteResponse { success }
DELETE/voices/{id}
Generate voice preview
client.voices.preview(VoicePreviewParams { provider, voiceId, model, 3 more } body, RequestOptionsoptions?): void
POST/voices/preview
Clone a voice
client.voices.clone(VoiceCloneParams { audio, contentType, language, name } body, RequestOptionsoptions?): VoiceCloneResponse { id, cartesiaVoiceId, createdAt, 2 more }
POST/voices/clone
ModelsExpand Collapse
VoiceListResponse { voices }
voices: Array<Voice>
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’).

isCloned?: boolean

Whether this is a cloned voice.

modelCompat?: "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"
VoiceRetrieveResponse { voice }
voice: Voice { id, name, description }
id: string
name: string
description?: string
VoiceDeleteResponse { success }
success: boolean
VoiceCloneResponse { id, cartesiaVoiceId, createdAt, 2 more }
id: string
cartesiaVoiceId: string
createdAt: string
language: string
name: string