Loading API documentation
Generate speech from text using VibeVoice
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/vibevoice", {
input: {
script: "Speaker 0: VibeVoice is now available on Fal. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
speakers: [{
preset: "Frank [EN]"
}, {
preset: "Carter [EN]"
}]
},
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/vibevoice", {
input: {
script: "Speaker 0: VibeVoice is now available on Fal. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
speakers: [{
preset: "Frank [EN]"
}, {
preset: "Carter [EN]"
}]
},
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/vibevoice", {
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/vibevoice", {
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.
script string* requiredThe script to convert to speech. Can be formatted with 'Speaker X:' prefixes for multi-speaker dialogues.
List of speakers to use for the script. If not provided, will be inferred from the script or voice samples.
seed integerRandom seed for reproducible generation.
cfg_scale floatCFG (Classifier-Free Guidance) scale for generation. Higher values increase adherence to text. Default value: 1.3
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"script": "Speaker 0: VibeVoice is now available on Fal. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
],
"cfg_scale": 1.3,
"enable_safety_checker": true
}The generated audio file containing the speech
duration float* requiredDuration of the generated audio in seconds
sample_rate integer* requiredSample rate of the generated audio
generation_time float* requiredTime taken to generate the audio in seconds
rtf float* requiredReal-time factor (generation_time / audio_duration). Lower is better.
{
"audio": {
"url": "https://storage.googleapis.com/falserverless/example_outputs/vibevoice.mp3"
},
"duration": 9.46,
"sample_rate": 24000,
"generation_time": 5.6,
"rtf": 0.53
}preset PresetEnumDefault voice preset to use for the speaker. Not used if audio_url is provided. Default value: "Alice [EN]"
Possible enum values: Alice [EN], Carter [EN], Frank [EN], Mary [EN] (Background Music), Maya [EN], Anchen [ZH] (Background Music), Bowen [ZH], Xinran [ZH]
audio_url stringURL to a voice sample audio file. If provided, preset will be ignored.
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.