API ReferenceText to Speech

Stream Speech

Returns a streaming output of generated audio

Headers

api-keystringOptional

Request

This endpoint expects an object.
textstringRequired

The text that is to be synthesised. e.g. ‘Hello there [pause 1s] friend’

voiceIdstringRequired

Use the GET /v1/speech/voices API to find supported voiceIds. You can use either the voiceId (e.g. en-US-natalie) or just the voice actor’s name (e.g. natalie).

channelTypestringOptionalDefaults to MONO

Valid values: STEREO, MONO

formatstringOptionalDefaults to WAV

Format of the generated audio file. Valid values: MP3, WAV

multiNativeLocalestringOptional

Specifies the language for the generated audio, enabling a voice to speak in multiple languages natively. Only available in the Gen2 model. Valid values: “en-US”, “en-UK”, “es-ES”, etc. Use the GET /v1/speech/voices endpoint to retrieve the list of available voices and languages.

pitchintegerOptional>=-50<=50
Pitch of the voiceover
pronunciationDictionarymap from strings to objectsOptional

An object used to define custom pronunciations.

Example 1: {“live”:{“type”: “IPA”, “pronunciation”: “laɪv”}}.

Example 2: {“2022”:{“type”: “SAY_AS”, “pronunciation”: “twenty twenty two”}}

rateintegerOptional>=-50<=50
Speed of the voiceover
sampleRatedoubleOptionalDefaults to 44100
Valid values are 8000, 24000, 44100, 48000
stylestringOptional
The voice style to be used for voiceover generation.
variationintegerOptional>=0<=5Defaults to 1
Higher values will add more variation in terms of Pause, Pitch, and Speed to the voice. Only available for Gen2 model.

Errors