Text To Dialogue
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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/elevenlabs/text-to-dialogue/eleven-v3", {
input: {
inputs: [{
text: "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
voice: "Aria"
}, {
text: "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
voice: "Charlotte"
}]
},
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);This model supports streaming requests. You can stream data directly to the model and get the result in real-time.
import { fal } from "@fal-ai/client";
const stream = await fal.stream("fal-ai/elevenlabs/text-to-dialogue/eleven-v3", {
input: {
inputs: [{
text: "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
voice: "Aria"
}, {
text: "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
voice: "Charlotte"
}]
}
});
for await (const event of stream) {
console.log(event);
}
const result = await stream.done();The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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/elevenlabs/text-to-dialogue/eleven-v3", {
input: {
inputs: [{
text: "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
voice: "Aria"
}, {
text: "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
voice: "Charlotte"
}]
},
webhookUrl: "https://optional.webhook.url/for/results",
});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/elevenlabs/text-to-dialogue/eleven-v3", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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/elevenlabs/text-to-dialogue/eleven-v3", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).
Read more about file handling in our file upload guide.
A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.
stability floatDetermines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion. Must be one of 0.0, 0.5, 1.0, else it will be rounded to the nearest value.
use_speaker_boost booleanThis setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.
A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request
seed integerRandom seed for reproducibility.
language_code stringLanguage code (ISO 639-1) used to enforce a language for the model. An error will be returned if language code is not supported by the model.
{
"inputs": [
{
"text": "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
"voice": "Aria"
},
{
"text": "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
"voice": "Charlotte"
}
],
"pronunciation_dictionary_locators": []
}The generated audio file
seed integer* requiredRandom seed for reproducibility.
{
"audio": {
"url": "https://v3.fal.media/files/zebra/XFeGS8Fq-q1eAPG2sSAo__output.mp3"
}
}text string* requiredThe dialogue text
voice string* requiredThe name or the ID of the voice to be used for the generation.
pronunciation_dictionary_id stringThe ID of the pronunciation dictionary.
version_id stringThe ID of the version of the pronunciation dictionary. If not provided, the latest version will be used.
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.