Eleven V4
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("elevenlabs/tts/eleven-v4", {
input: {
text: "[excited] Hello! Welcome to Eleven v4."
},
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);This model supports streaming requests. You can stream data directly to the model and get the result in real-time.
import { fal } from "@fal-ai/client";
const stream = await fal.stream("elevenlabs/tts/eleven-v4", {
input: {
text: "[excited] Hello! Welcome to Eleven v4."
}
});
for await (const event of stream) {
console.log(event);
}
const result = await stream.done();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("elevenlabs/tts/eleven-v4", {
input: {
text: "[excited] Hello! Welcome to Eleven v4."
},
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("elevenlabs/tts/eleven-v4", {
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("elevenlabs/tts/eleven-v4", {
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.
text string* requiredThe text to convert to speech. Supports audio tags such as [whispering] and IPA pronunciation enclosed in forward slashes.
voice stringThe voice to use for speech generation Default value: "Rachel"
stability floatVoice stability. Lower values allow more expressive delivery; higher values make delivery more consistent. Default value: 0.5
similarity_boost floatHow closely the output follows the reference voice. Higher values increase similarity but may reduce naturalness. Default value: 0.75
seed integerSeed for best-effort reproducibility. Identical output is not guaranteed.
language_code stringLanguage code (ISO 639-1) for speech generation and text normalization.
output_format OutputFormatEnumOutput format of the generated audio. Formatted as codec_sample_rate_bitrate. Default value: "mp3_44100_128"
Possible enum values: mp3_22050_32, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_8000, pcm_16000, pcm_22050, pcm_24000, pcm_44100, pcm_48000, ulaw_8000, alaw_8000, opus_48000_32, opus_48000_64, opus_48000_96, opus_48000_128, opus_48000_192
enable_safety_checker booleanCheck input content for safety. Disabling requires account authorization. Default value: true
apply_text_normalization ApplyTextNormalizationEnumWhether to normalize text such as numbers and dates before generation. Default value: "auto"
Possible enum values: auto, on, off
timestamps booleanWhether to return character-level timing information with the generated audio.
{
"text": "[excited] Hello! Welcome to Eleven v4.",
"voice": "Aria",
"stability": 0.5,
"similarity_boost": 0.75,
"output_format": "mp3_44100_128",
"enable_safety_checker": true,
"apply_text_normalization": "auto"
}The generated audio file
Timestamps for each word in the generated speech. Only returned if timestamps is set to True in the request.
{
"audio": {
"url": "https://v3.fal.media/files/zebra/zJL_oRY8h5RWwjoK1w7tx_output.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.