Loading API documentation
Generate
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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/index-tts-2/text-to-speech", {
input: {
audio_url: "https://storage.googleapis.com/falserverless/example_inputs/index-tts-2/tts_in.mp3",
prompt: "Hide! He's coming! He's coming to get us!"
},
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"
});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/index-tts-2/text-to-speech", {
input: {
audio_url: "https://storage.googleapis.com/falserverless/example_inputs/index-tts-2/tts_in.mp3",
prompt: "Hide! He's coming! He's coming to get us!"
},
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/index-tts-2/text-to-speech", {
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/index-tts-2/text-to-speech", {
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);Read more about file handling in our file upload guide.
audio_url string* requiredThe audio file to generate the speech from.
prompt string* requiredThe speech prompt to generate
emotional_audio_url stringThe emotional reference audio file to extract the style from.
strength floatThe strength of the emotional style transfer. Higher values result in stronger emotional influence. Default value: 1
The strengths of individual emotions for fine-grained control.
should_use_prompt_for_emotion booleanWhether to use the prompt to calculate emotional strengths, if enabled it will overwrite the emotional_strengths values. If emotion_prompt is provided, it will be used to instead of prompt to extract the emotional style.
emotion_prompt stringThe emotional prompt to influence the emotional style. Must be used together with should_use_prompt_for_emotion.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"audio_url": "https://storage.googleapis.com/falserverless/example_inputs/index-tts-2/tts_in.mp3",
"prompt": "Hide! He's coming! He's coming to get us!",
"strength": 1,
"emotional_strengths": null,
"should_use_prompt_for_emotion": true,
"emotion_prompt": "You scared me to death! What are you, a ghost?",
"enable_safety_checker": true
}The generated audio file in base64 format.
{
"audio": "https://storage.googleapis.com/falserverless/example_outputs/index-tts-2/tts_out.mp3"
}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.
happy floatStrength of happiness emotion
angry floatStrength of anger emotion
sad floatStrength of sadness emotion
afraid floatStrength of fear emotion
disgusted floatStrength of disgust emotion
melancholic floatStrength of melancholic emotion
surprised floatStrength of surprise emotion
calm floatStrength of calm emotion