API Reference

Convert SSML To Speech

post
https://api.play.ht/api/v1/convert/

This endpoint is used to trigger text to speech conversion.

It can generate text for Standard & Premium (S&P) voices. The identifiers for these voices look like en-US-JennyNeural.

If you are using PlayHT voices (their identifiers look like larry or a URL), please refer to the Generate Audio From Text endpoint page.


The request body for this /v1/convert endpoint must contain the SSML to be converted to speech, along with the voice to be used for the conversion. The response will contain data about the conversion job created in JSON format.

To generate audio from SSML, please provide the ssml field in the request body. It is an array of SSML strings. An SSML string looks like: <speak><p>Hello my friend <break time="0.5s"/></p></speak>.

Use the transcriptionId in the response to check the conversion status in the Get Article Conversion Status endpoint endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
ssml
array of strings
required
Defaults to <speak><p>Hello my friend. <break time="0.5s"/> Hmm...</p></speak>

Array of strings, where each string represents a paragraph in SSML format. Learn more about SSML. Not all SSML features are supported with all voices.

Example: <speak><p>Hello my friend <break time="0.5s"/></p></speak>

ssml*
string
required
Defaults to en-US-JennyNeural

Voice used to synthesize the text. Refer to the List Standard & Premium Voices endpoint for a list of supported voices.

string

A name to your file. You can use this name to find the audio in your Play.ht dashboard.

string

String representing the tone and accent of the voice to read the text. Make sure the value for narrationStyle is supported by the voice in your request. Refer to the List Standard & Premium Voices endpoint for more details.

string

String in the format <number>%, where <number> is in the closed interval of [20, 200]. Use this to speed-up, or slow-down the speaking rate of the speech.

pronunciations
array of objects
pronunciations
boolean

When enabled, the audio will be trimmed to remove any silence from the end of the file.

string

Pass this to update an existing audio file.

Responses

Updated 8 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago