Skip to main content
POST
/
api
/
v1
/
tts
/
stream
cURL
curl --request POST \
  --url https://api.play.ai/api/v1/tts/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-USER-ID: <api-key>' \
  --data '{
  "model": "PlayDialog",
  "text": "Country Mouse: Welcome to my humble home, cousin! Town Mouse: Thank you, cousin. It'\''s quite... peaceful here. Country Mouse: It is indeed. I hope you'\''re hungry. I'\''ve prepared a simple meal of beans, barley, and fresh roots. Town Mouse: Well, it'\''s... earthy. Do you eat this every day?",
  "voice": "s3://voice-cloning-zero-shot/baf1ef41-36b6-428c-9bdf-50ba54682bd8/original/manifest.json"
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

​
X-USER-ID
string
header
required

Your unique user ID from PlayAI.

Body

application/json
​
model
enum<string>
required

The voice engine used to synthesize the voice. Must be either Play3.0-mini or PlayDialog.

  • Dialog 1.0: Our flagship model with best quality and multi-turn dialogue capabilities.
  • Play 3.0 Mini: Our fast and efficient model for single-voice text-to-speech.

💡 Tip: Check out the How to use Dialog 1.0 Text-to-Speech API guide for a step-by-step approach to using the Dialog 1.0 API.

Available options:
PlayDialog,
Play3.0-mini
Example:

"PlayDialog"

​
text
string
required

The text to be converted to speech. Limited to 20k characters for Play3.0-mini, 50k characters for PlayDialog

Example:

"Country Mouse: Welcome to my humble home, cousin! Town Mouse: Thank you, cousin. It's quite... peaceful here. Country Mouse: It is indeed. I hope you're hungry. I've prepared a simple meal of beans, barley, and fresh roots. Town Mouse: Well, it's... earthy. Do you eat this every day?"

​
voice
string
required

The unique ID for a voice to be used. See voice2 for multi-turn dialogue generations.

💡 Tip: Check out the How to Get ID of Voices guide

Example:

"s3://voice-cloning-zero-shot/baf1ef41-36b6-428c-9bdf-50ba54682bd8/original/manifest.json"

​
voice2
string

The unique ID for a voice to be used as second character on multi-turn dialogue generations. Only supported with PlayDialog model.

💡 Tip: Check out the How to Get ID of Voices guide

Example:

"s3://voice-cloning-zero-shot/baf1ef41-36b6-428c-9bdf-50ba54682bd8/original/manifest.json"

​
quality
enum<string>

The quality of the generated audio. Only supported with Play3.0-mini model.

Available options:
draft,
low,
medium,
high,
premium
​
outputFormat
enum<string> | null
default:mp3

The format for the output audio.

Available options:
mp3,
mulaw,
raw,
wav,
ogg,
flac
​
speed
number
default:1

Control how fast the generated audio should be, where 1.0 is the natural pace.

Required range: 0 < x <= 5
Example:

0.8

​
sampleRate
number
default:24000

The sample rate of the output audio in Hz.

Required range: 8000 <= x <= 48000
Example:

24000

​
seed
number | null

The seed used to generate the audio. If equal to null or not provided, a random seed will be used. Useful to control the reproducibility of the generated audio. Assuming all other properties didn't change, a fixed seed should always generate the exact same audio file.

Required range: x >= 0
Example:

256

​
temperature
number | null

The temperature used to generate the audio. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.

Required range: 0 <= x <= 2
Example:

1.5

​
voiceGuidance
number | null

The voice guidance used to generate the audio. Only supported with Play3.0-mini model. Use lower numbers to reduce how unique your chosen voice will be compared to other voices. Higher numbers will maximize its individuality.

Required range: 1 <= x <= 6
Example:

null

​
styleGuidance
number | null

The style guidance used to generate the audio. Only supported with Play3.0-mini model. Use lower numbers to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.

Required range: 1 <= x <= 30
Example:

null

​
textGuidance
number | null

The text guidance used to generate the audio. Only supported with Play3.0-mini model. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.

Required range: 1 <= x <= 2
Example:

1.25

​
turnPrefix
string | null

The prefix to indicate the start of a turn in a multi-turn dialogue with voice. Only supported with PlayDialog model.

Example:

"Country Mouse:"

​
turnPrefix2
string | null

The prefix to indicate the start of a turn in a multi-turn dialogue with voice2. Only supported with PlayDialog model.

Example:

"Town Mouse:"

​
prompt
string | null

The prompt to be used for voice. Only supported with PlayDialog model.

​
prompt2
string | null

The prompt to be used for voice2. Only supported with PlayDialog model.

​
voiceConditioningSeconds
number | null
default:20

The number of seconds of conditioning to use from the selected voice. Only supported with PlayDialog model. Lower values generate audio less similar to the cloned voice, but lead to more model stability and expressiveness. Higher values create output more similar to the cloned voice, but can lead to model instability and reduced expressiveness.

Example:

20

​
voiceConditioningSeconds2
number | null
default:20

The number of seconds of conditioning to use from the selected voice2. Only supported with PlayDialog model. Lower values generate audio less similar to the cloned voice, but lead to more model stability and expressiveness. Higher values create output more similar to the cloned voice, but can lead to model instability and reduced expressiveness.

Example:

20

​
language
enum<string>
default:english

The language of the voices. Defaults to english.

Available options:
afrikaans,
albanian,
amharic,
arabic,
bengali,
bulgarian,
catalan,
croatian,
czech,
danish,
dutch,
english,
french,
galician,
german,
greek,
hebrew,
hindi,
hungarian,
indonesian,
italian,
japanese,
korean,
malay,
mandarin,
polish,
portuguese,
russian,
serbian,
spanish,
swedish,
tagalog,
thai,
turkish,
ukrainian,
urdu,
xhosa
Example:

"english"

Response

A stream of audio bytes.

The response is of type file.