Chatterbox Text to Speech
About
Generate Multilingual Tts
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
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
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/chatterbox/text-to-speech/multilingual", {
input: {
text: "Last month, we reached a new milestone with two billion views on our YouTube channel."
},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API 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.
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/chatterbox/text-to-speech/multilingual", {
input: {
text: "Last month, we reached a new milestone with two billion views on our YouTube channel."
},
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/chatterbox/text-to-speech/multilingual", {
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/chatterbox/text-to-speech/multilingual", {
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);
Auto uploads
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.
5. Schema#
Input#
text
string
* requiredThe text to be converted to speech (maximum 300 characters). Supports 23 languages including English, French, German, Spanish, Italian, Portuguese, Hindi, Arabic, Chinese, Japanese, Korean, and more.
voice
string
Language code for synthesis. In case using custom please provide audio url and select custom_audio_language. Default value: "english"
custom_audio_language
CustomAudioLanguageEnum
If using a custom audio URL, specify the language of the audio here. Ignored if voice is not a custom url.
Possible enum values: english, arabic, danish, german, greek, spanish, finnish, french, hebrew, hindi, italian, japanese, korean, malay, dutch, norwegian, polish, portuguese, russian, swedish, swahili, turkish, chinese
exaggeration
float
Controls speech expressiveness and emotional intensity (0.25-2.0). 0.5 is neutral, higher values increase expressiveness. Extreme values may be unstable. Default value: 0.5
temperature
float
Controls randomness and variation in generation (0.05-5.0). Higher values create more varied speech patterns. Default value: 0.8
cfg_scale
float
Configuration/pace weight controlling generation guidance (0.0-1.0). Use 0.0 for language transfer to mitigate accent inheritance. Default value: 0.5
seed
integer
Random seed for reproducible results. Set to 0 for random generation, or provide a specific number for consistent outputs.
{
"text": "Last month, we reached a new milestone with two billion views on our YouTube channel.",
"voice": "english",
"exaggeration": 0.5,
"temperature": 0.8,
"cfg_scale": 0.5
}
Output#
The generated multilingual speech audio file
{
"audio": {
"url": "https://v3.fal.media/files/example/multilingual_speech_output.wav"
}
}
Other types#
ChatterboxRequest#
text
string
* requiredThe text to be converted to speech. You can additionally add the following emotive tags: <laugh>, <chuckle>, <sigh>, <cough>, <sniffle>, <groan>, <yawn>, <gasp>
audio_url
string
Optional URL to an audio file to use as a reference for the generated speech. If provided, the model will try to match the style and tone of the reference audio. Default value: "https://storage.googleapis.com/chatterbox-demo-samples/prompts/male_rickmorty.mp3"
exaggeration
float
Exaggeration factor for the generated speech (0.0 = no exaggeration, 1.0 = maximum exaggeration). Default value: 0.25
temperature
float
Temperature for generation (higher = more creative). Default value: 0.7
cfg
float
Default value: 0.5
seed
integer
Useful to control the reproducibility of the generated audio. Assuming all other properties didn't change, a fixed seed should always generate the exact same audio file. Set to 0 for random seed..
ChatterboxVCRequest#
source_audio_url
string
* requiredtarget_voice_audio_url
string
Optional URL to an audio file to use as a reference for the generated speech. If provided, the model will try to match the style and tone of the reference audio.
File#
url
string
* requiredThe 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.
file_data
string
File data