Skip to content
Voices · Object

The Voice object

A voice an assistant can speak with: a preset voice of its provider, or a voice your organization cloned.

Fields

  • provider"cartesia" | "elevenlabs" | "gradium"

    The provider of the voice.

  • idstring

    ID of the voice at its provider: voice.id of an assistant.

    Example "4325f426-c4e0-418e-a0e5-97fcdfcdf8e6"at least 1 character

  • namestring

    The name of the voice.

    Example "Camille"

  • descriptionstring

    The description of the voice.

  • languageenum (8 values)

    The voice's language, which is the language of the calls made with it.

    "en"

    English

    "fr"

    French

    "es"

    Spanish

    "de"

    German

    "it"

    Italian

    "pt"

    Portuguese

    "ru"

    Russian

    "zh"

    Mandarin Chinese

  • accentstringoptional

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

  • genderstringoptional

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

  • isClonedbooleanoptional

    Whether this is a cloned voice.

  • modelCompatenum (4 values)optional

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

    Possible values"universal""sonic-3""sonic-3.5""sonic-3.6"