DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

PlayAI Text-to-Speech Dialog Text to Audio

fal-ai/playai/tts/dialog
Generate natural-sounding multi-speaker dialogues, and audio. Perfect for expressive outputs, storytelling, games, animations, and interactive media.
Inference
Commercial use
Partner
PlaygroundAPI

About

Dialog

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/playai/tts/dialog", {
  input: {
    input: "Speaker 1: Hey, did you catch the game last night?
  Speaker 2: Of course! What a match—it had me on the edge of my seat.
  Speaker 1: Same here! That last-minute goal was unreal. Who's your MVP?
  Speaker 2: Gotta be the goalie. Those saves were unbelievable.
  Speaker 1: Absolutely. Saved the day, literally! Are you planning to watch the next game?
  Speaker 2: Oh, you bet. I’m already stocked up on snacks!
  "
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/playai/tts/dialog", {
  input: {
    input: "Speaker 1: Hey, did you catch the game last night?
  Speaker 2: Of course! What a match—it had me on the edge of my seat.
  Speaker 1: Same here! That last-minute goal was unreal. Who's your MVP?
  Speaker 2: Gotta be the goalie. Those saves were unbelievable.
  Speaker 1: Absolutely. Saved the day, literally! Are you planning to watch the next game?
  Speaker 2: Oh, you bet. I’m already stocked up on snacks!
  "
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/playai/tts/dialog", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/playai/tts/dialog", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

input string* required

The dialogue text with turn prefixes to distinguish speakers.

voices list<LDMVoiceInput>

A list of voice definitions for each speaker in the dialogue. Must be between 1 and 2 voices. Default value: [object Object],[object Object]

response_format ResponseFormatEnum

The format of the response. Default value: "url"

Possible enum values: url, bytes

seed integer

An integer number greater than or equal to 0. 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.

{
  "input": "Speaker 1: Hey, did you catch the game last night?\nSpeaker 2: Of course! What a match—it had me on the edge of my seat.\nSpeaker 1: Same here! That last-minute goal was unreal. Who's your MVP?\nSpeaker 2: Gotta be the goalie. Those saves were unbelievable.\nSpeaker 1: Absolutely. Saved the day, literally! Are you planning to watch the next game?\nSpeaker 2: Oh, you bet. I’m already stocked up on snacks!\n",
  "voices": [
    {
      "voice": "Jennifer (English (US)/American)",
      "turn_prefix": "Speaker 1: "
    },
    {
      "voice": "Furio (English (IT)/Italian)",
      "turn_prefix": "Speaker 2: "
    }
  ],
  "response_format": "url",
  "seed": null
}

Output#

audio AudioFile* required

The generated audio file.

{
  "audio": {
    "file_size": 584109,
    "duration": 24.3,
    "file_name": "33dd5f07-f834-4080-aaac-4a253ce1660b.mp3",
    "content_type": "audio/mpeg",
    "url": "https://fal-api-audio-uploads.s3.amazonaws.com/33dd5f07-f834-4080-aaac-4a253ce1660b.mp3"
  }
}

Other types#

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

file_data string

File data

AudioFile#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

file_data string

File data

duration float* required

The duration of the audio file in seconds.

Related Models