AvailableVoice

One voice a Call Agent can be set to speak in.

Returned by GET /v1/available-voices. Put this voice's provider and id into a Call Agent's voices list to let its calls speak in this voice; the other fields help a person choose. Only voices your organization is permitted to use are listed.

  • id
    Type: string
    min length:  
    1
    max length:  
    512
    required

    The voice's identifier. Store it, with its provider, in a Call Agent's voices list.

  • name
    Type: string
    min length:  
    1
    required

    The voice's display name.

  • provider
    Type: TtsProviderenum
    required

    The speech provider this voice comes from.

    values
    cartesiafish
  • description
    Type: stringnullable

    A short description of how the voice sounds, when the provider supplies one.

  • gender
    Type: VoiceGenderenum

    The voice's gender, so a person can keep a Call Agent's persona name and its voice consistent. One of Male, Female, Neutral, or Unknown. Unknown means the speech provider gives no single recognized gender signal for this voice — none at all, an unrecognized one, or conflicting ones. The field is always present and never null.

    values
    MaleFemaleNeutralUnknown
  • language
    Type: stringnullable

    The primary language the voice speaks, as a short code such as "en", when the provider reports one.