API Reference

Request URL

Verb/Method	POST
URL Elements	https://(hostname)
Sample URL	https://revapi.reverieinc.com/

Header

Header Name	Description
Content-Type	The format of the data to be posted.	application/JSON
REV-API-KEY	A unique key/token provided by Reverie to identify the user using the Localization API.	-
REV-APP-ID	The unique account ID to identify the user and the default account settings.	-
REV-APPNAME	The parameter to identify the API.	tts
speaker	The desired language and voice code for synthesizing the audio file	Specify the speaker’s code with respect to the language. Refer to Supporting Speaker Code section for valid speaker code.

Request

Element	Type	Is Mandatory?	Description
text or ssml	string/ array	Yes	The plain text or SSML input to synthesize an audio output. If you want to follow W3 standards, the ssml field must be used and not the text field.
speed	float (seconds)	No	The speech rate of the audio file. Allows values: from 0.5 (slowest speed rate) up to 1.5 (fastest speed rate). Note: By default, speed = 1 (normal speed).
pitch	float (seconds)	No	Speaking pitch, in the range Allows values: from -3 up tp 3. 3 indicates an increase of 3 semitones from the original pitch. -3 indicates a decrease of 3 semitones from the original pitch. Note: By default, the pitch = 0 (zero)
sample_rate	integer	No	The sampling rate (in hertz) to synthesize the audio output. Refer to Supporting Sampling Rate section, to know the supporting audio sample rates. Note: By default, the sample_rate = 22050 Hz (22.05kHz)
format	string	No	The speech audio format to generate the audio file. Refer to Supporting Audio Format section, to know the supporting audio formats. Note: By default, the format = WAV

Handling Error

The TTS API raises exceptions for many reasons, such as failed conversions, invalid parameters, authentication errors, and network unavailability. It will provide more specific machine-readable messages with an error response so that users can react to errors more effectively.

Refer to API Messages section to view the list of error messages and its description.

{
    "success": false,
    "cause": "no `text` given"
}