TTSAudio

Speech

Gets the speech data for the given input

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
inputstringRequired

Plain text or SSML to be synthesized to speech. Refer to https://docs.sws.speechify.com/docs/api-limits for the input size limits. Emotion, Pitch and Speed Rate are configured in the ssml input, please refer to the ssml documentation for more information: https://docs.sws.speechify.com/docs/ssml#prosody

voice_idstringRequired

Id of the voice to be used for synthesizing speech. Refer to /v1/voices endpoint for available voices

audio_formatenumOptionalDefaults to wav

The format for the output audio. Note, that the current default is “wav”, but there’s no guarantee it will not change in the future. We recommend always passing the specific param you expect.

Allowed values:
languagestringOptional

Language of the input. Follow the format of an ISO 639-1 language code and an ISO 3166-1 region code, separated by a hyphen, e.g. en-US. Please refer to the list of the supported languages and recommendations regarding this parameter: https://docs.sws.speechify.com/docs/language-support.

modelenumOptionalDefaults to simba-english

Model used for audio synthesis. simba-base and simba-turbo are deprecated. Use simba-english or simba-multilingual instead.

Allowed values:
optionsobjectOptional

GetSpeechOptionsRequest is the wrapper for request parameters to the client

Response

audio_datastringformat: "byte"

Synthesized speech audio, Base64-encoded

audio_formatenum

The format of the audio data

Allowed values:
billable_characters_countlong

The number of billable characters processed in the request.

speech_marksobject

It is used to annotate the audio data with metadata about the synthesis process, like word timing or phoneme details.

Errors