API Reference

Create Batch TTS Job

post
https://api.play.ht/api/v2/tts/batches

Creates a new batch Text-to-Speech (TTS) job that converts multiple input texts into audio asynchronously. The API responds with information about the newly created batch TTS job. The created jobs are processed, and their status can be tracked via the GET endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
url

A global webhook URL for the entire batch. Individual job webhooks take precedence if provided.

jobs
array of objects
required
length between 1 and 50

An array of child jobs to be processed in this batch.

jobs*
string
length between 1 and 30

User-defined custom identifier for a child job. Must contain only letters, numbers, dashes, or underscores. Max length 30.

url

URL to send webhook notifications to.

string
enum
required

The voice engine to use for synthesis.

Allowed:
string
required

The text to synthesize.

string
required
Defaults to s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json

The unique ID for a PlayHT or Cloned Voice.

string
enum

Quality of the generated audio.

Allowed:
string
enum

Format of the generated audio.

Allowed:
float | null
0.1 to 5

Speed of the speech.

integer | null
8000 to 48000

Sample rate of the audio in Hz.

integer | null
≥ 0

Seed for reproducibility.

float | null
0 to 2

Controls randomness. Higher values are more random.

string
enum

Language of the text/voice.

string
Defaults to s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json

The unique ID for a PlayHT or Cloned Voice.

string | null

Prefix for the primary speaker in dialogs.

string | null

Prefix for the secondary speaker in dialogs.

integer | null

Seconds of conditioning for the primary voice.

integer | null

Seconds of conditioning for the secondary voice.

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