Skip to main content
Versionv1
API docs by Redocly

TTS API (v1)

Download OpenAPI specification:Download

Voices

Get TTS Voices

Get a list of available TTS voices supported by the Voice applications.

Authorizations:
X-CM-PRODUCTTOKEN
query Parameters
IsPremium
boolean
Example: IsPremium=true

Whether only premium or non-premium voices should be returned. If left empty, both premium and non premium voices will be returned.

Language
string
Example: Language=en-US

ISO-639 language code and ISO-3166 country code combination to filter the voices on. It's also possible to only filter on languages independent of countries by only supplying the ISO-639 code (e.g. en).

Gender
string (Gender)
Enum: "Male" "Female"
Example: Gender=Female

Gender to filter on.

Responses

Response samples

Content type
No sample

Get TTS Voice preview

Returns a preview of the given TTS voice.

Authorizations:
X-CM-PRODUCTTOKEN
Request Body schema:

The voice to preview

language
required
string non-empty ^[a-zA-Z]{2}-[a-zA-Z]{2}$

ISO-639 language code and ISO-3166 country code.

gender
required
string (Gender)
Enum: "Male" "Female"

Available genders for TTS voices.

voiceNumber
required
integer <int32> > 0

The voice number, used to identify this voice.

isPremium
required
boolean

Whether or not this is a premium TTS voice.

encoding
string (Encoding)
Enum: "Mp3" "Ogg" "Pcm"

The encoding of the audio.

Responses

Request samples

Content type
{
  • "language": "en-GB",
  • "gender": "Male",
  • "voiceNumber": 2,
  • "isPremium": true,
  • "encoding": "Mp3"
}