This endpoint only supports text less than or equal to 1200 characters
Endpoint
Authentication
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | Yes |
Content-Type | application/json | Yes |
Body Parameters
| Field | Type | Description | Required | Options | Default |
|---|---|---|---|---|---|
text | String | the text to process | yes | ||
voice_accent | String | Accent for the speech voice | yes | see page of supported accents | |
voice_gender | String | Accent for the speech voice | yes | male / female | |
voice_language | String | Language of the input text | no | see page of supported languages | en |
output_audio_format | String | Specify the output audio format | no | see list of supported audio formats below | wav |
Supported Output Audio Formats
| Format | Extensions |
|---|---|
| WAV | .wav |
| OPUS | .opus |
Supported Language And Accents
Supported Languages And Accents
Comprehensive list of languages and accents supported
Basic request and response sample
- Language|English
- Language|Hausa
Requests
Response
The text-id in the response should be used to get the file’s status with the Get TTS Status endpoint
Error Responses
400 | Max characters limit exceed
400 | Max characters limit exceed
Error response if the max character limit is exceed,
Please refer to the list of support language,accent lists Supported Voice language and accents
JSON
400 | Invalid text voice language
400 | Invalid text voice language
Error response if an unsupported language code was sent,
Please refer to the list of support language,accent lists Supported Voice language and accents
JSON
400 | Invalid text voice accent
400 | Invalid text voice accent
Error response if the voice_accent sent is not supported under the selected voice_language,
Please refer to the list of support language,accent lists Supported Voice language and accents
JSON
400 | Invalid text voice gender
400 | Invalid text voice gender
Error response if the voice_gender sent is not supported under the selected voice_accent,
Please refer to the list of support language,accent lists Supported Voice language and accents
JSON
400 | invalid output audio format
400 | invalid output audio format
Error response if the output_audio_format is not supported,
Please refer to the list of supported output_audio_format above
JSON
