✨ NEW: Seedream 4.0 Edit - Best Model for Image Editing
DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

VibeVoice 7B Text to Speech

fal-ai/vibevoice/7b
Generate long, expressive multi-voice speech using Microsoft's powerful TTS
Inference
Commercial use
PlaygroundAPI

About

Generate speech from text using VibeVoice-7b

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/vibevoice/7b", {
  input: {
    script: "Speaker 0: VibeVoice is now available on Fal. Isn't that right, Carter?
  Speaker 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);

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/vibevoice/7b", {
  input: {
    script: "Speaker 0: VibeVoice is now available on Fal. Isn't that right, Carter?
  Speaker 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",
});

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/vibevoice/7b", {
  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/vibevoice/7b", {
  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#

script string* required

The script to convert to speech. Can be formatted with 'Speaker X:' prefixes for multi-speaker dialogues.

speakers list<VibeVoiceSpeaker>* required

List of speakers to use for the script. If not provided, will be inferred from the script or voice samples.

seed integer

Random seed for reproducible generation.

cfg_scale float

CFG (Classifier-Free Guidance) scale for generation. Higher values increase adherence to text. Default value: 1.3

{
  "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
}

Output#

audio File* required

The generated audio file containing the speech

duration float* required

Duration of the generated audio in seconds

sample_rate integer* required

Sample rate of the generated audio

generation_time float* required

Time taken to generate the audio in seconds

rtf float* required

Real-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
}

Other types#

VibeVoiceSpeaker#

preset PresetEnum

Default 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 string

URL to a voice sample audio file. If provided, preset will be ignored.

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.

Related Models