Request BodyContent Type : application/json
Request Parameters
Enginestring
standard, neural
VoiceIdenum
Please see the list below for all Available Voice Ids
LanguageCodeenum
en-US, en-GB, en-AU (Please refer below to Available Voices) multi-lang - For Pro Voices.
AccentCodeenum
Please refer below to Available Voices
Textstring
The audio request text. The length of this string is limited to 10,000 characters per request, the requests above 3,000 characters may take a little longer to generate a speech. If SSML tags support required then please let us know.
OutputFormatenum
We suggest to use mp3 in real-time applications. Wav files could take longer time to convert the audio
ResponseTypeenum
By default, we choose file, which results audio in a downlodable url file. stream will results audio in AudioBuffer format, which can be saved to a buffer, or saved to a file. stream will save your addional HTTP request for downloading audio file via URL.
FileStorenumber
You can specify the duration for retaining your converted output audio file in hours. The maximum limit allowed is up to 240 hours, which is equivalent to 10 days. This parameter is not supported on ResponseType: stream.
CustomFileNamestring
You can able to custom-named Output audio file as specified. This parameter is not supported on ResponseType: stream.
SampleRateenum
Always use 48000, we automatically choose for the best audio output on all voices
Effectstring
breathing, soft, whispered - Only supports standard Engine ai1 voices. conversational - Only support on neural Engine en-US - ai1-Joanna, ai1-Matthew, ai3-Aria, ai3-Jenny, cmn-CN - ai3-cmn-CN-Xiaoxiao. news - Only support on neural Engine en-GB - ai1-Amy, en-US - ai3-Jony, ai3-Aria, ai3-Jenny, es-US - ai1-es-US-Lupe customersupport - Only support on neural Engine en-US - ai3-Aria, ai3-Jenny, cmn-CN - ai3-cmn-CN-Yunyang. assistant - Only support on neural Engine en-US - ai3-Aria, ai3-Jenny. happy - Only support on neural Engine en-US - ai3-Aria, cmn-CN - ai3-cmn-CN-Yunye, ai3-cmn-CN-Xariyah, ai3-cmn-CN-Xiomara, ai3-cmn-CN-Carissa, ai3-cmn-CN-Xylia, ai3-cmn-CN-Xander. empathic - Only support on neural Engine en-US - ai3-Aria. clam - Only support on neural Engine cmn-CN - ai3-cmn-CN-Yunye. whispered, happy, sad, angry, excited, friendly, hopeful, shouting, terrified, unfriendly: ai3-Aria, ai3-Jenny, ai3-Jony, ai3-en-US-Alexander, ai3-en-US-Madison, ai3-en-US-Jayden, ai3-en-US-Ashley, ai3-en-US-Joshua
MasterSettingsenum
advanced_v1 - It directly connects to AI Engines, and characters are counted with each convert. advanced_v2 - If you only adjust MasterVolume, MasterSpeed, or MasterPitch without updating the VoiceId or Text, characters will not be counted. Please note, this will add an additional 200ms time delay to the initial request.
MasterVolumenumber
0 is the default (-20 to 20)
MasterSpeednumber
0 is the default (-100 to 100)
MasterPitchnumber
0 is the default (-100 to 100)