Loading API documentation
Text To Speech
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/f5-tts", {
input: {
gen_text: "I don't really care what you call me. I've been a silent spectator, watching species evolve, empires rise and fall. But always remember, I am mighty and enduring. Respect me and I'll nurture you; ignore me and you shall face the consequences.",
ref_audio_url: "https://storage.googleapis.com/falserverless/example_inputs/reference_audio.wav",
model_type: "F5-TTS"
},
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);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/f5-tts", {
input: {
gen_text: "I don't really care what you call me. I've been a silent spectator, watching species evolve, empires rise and fall. But always remember, I am mighty and enduring. Respect me and I'll nurture you; ignore me and you shall face the consequences.",
ref_audio_url: "https://storage.googleapis.com/falserverless/example_inputs/reference_audio.wav",
model_type: "F5-TTS"
},
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/f5-tts", {
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/f5-tts", {
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.
gen_text string* requiredThe text to be converted to speech. Maximum 5000 characters.
ref_audio_url string* requiredThe URL of the reference audio file.
ref_text stringThe reference text to be used for TTS. If not provided, an ASR (Automatic Speech Recognition) model will be used to generate the reference text. Default value: ""
model_type ModelTypeEnum* requiredThe name of the model to be used for TTS.
Possible enum values: F5-TTS, E2-TTS
remove_silence booleanWhether to remove the silence from the audio file. Default value: true
{
"gen_text": "I don't really care what you call me. I've been a silent spectator, watching species evolve, empires rise and fall. But always remember, I am mighty and enduring. Respect me and I'll nurture you; ignore me and you shall face the consequences.",
"ref_audio_url": "https://storage.googleapis.com/falserverless/example_inputs/reference_audio.wav",
"ref_text": "Some call me nature, others call me mother nature.",
"model_type": "F5-TTS",
"remove_silence": true
}The audio file containing the generated speech.
{
"audio_url": {
"url": "https://v2.fal.media/files/8535dd59e911496a947daa35c07e67a3_tmplkcy6tut.wav",
"content_type": "audio/wav",
"file_name": "8535dd59e911496a947daa35c07e67a3_tmplkcy6tut.wav",
"file_size": 4404019
}
}url string* requiredcontent_type stringDefault value: "audio/wav"
file_name stringDefault value: "8535dd59e911496a947daa35c07e67a3_tmplkcy6tut.wav"
file_size integerThe size of the file in bytes.