Elevenlabs Text to Audio
About
Text To Dialogue
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/elevenlabs/text-to-dialogue/eleven-v3", {
input: {
inputs: [{
text: "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
voice: "Aria"
}, {
text: "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
voice: "Charlotte"
}]
},
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);
Streaming#
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("fal-ai/elevenlabs/text-to-dialogue/eleven-v3", {
input: {
inputs: [{
text: "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
voice: "Aria"
}, {
text: "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
voice: "Charlotte"
}]
}
});
for await (const event of stream) {
console.log(event);
}
const result = await stream.done();
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/elevenlabs/text-to-dialogue/eleven-v3", {
input: {
inputs: [{
text: "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
voice: "Aria"
}, {
text: "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
voice: "Charlotte"
}]
},
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/elevenlabs/text-to-dialogue/eleven-v3", {
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/elevenlabs/text-to-dialogue/eleven-v3", {
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#
A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.
stability
 float
Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion.
use_speaker_boost
 boolean
This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.
A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request
seed
 integer
Random seed for reproducibility.
{
"inputs": [
{
"text": "[applause] Thank you all for coming tonight! Today we have a very special guest with us.",
"voice": "Aria"
},
{
"text": "[gulps] ... [strong canadian accent] [excited] Hello everyone! Thank you all for having me tonight on this special day.",
"voice": "Charlotte"
}
],
"pronunciation_dictionary_locators": []
}
Output#
The generated audio file
seed
 integer
* requiredRandom seed for reproducibility.
{
"audio": {
"url": "https://v3.fal.media/files/zebra/XFeGS8Fq-q1eAPG2sSAo__output.mp3"
}
}
Other types#
SpeechToTextRequest#
audio_url
 string
* requiredURL of the audio file to transcribe
language_code
 string
Language code of the audio
tag_audio_events
 boolean
Tag audio events like laughter, applause, etc. Default value: true
diarize
 boolean
Whether to annotate who is speaking Default value: true
TextToSpeechStreamRequest#
text
 string
* requiredThe text to convert to speech
voice
 string
The voice to use for speech generation Default value: "Rachel"
stability
 float
Voice stability (0-1) Default value: 0.5
similarity_boost
 float
Similarity boost (0-1) Default value: 0.75
style
 float
Style exaggeration (0-1)
speed
 float
Speech speed (0.7-1.2). Values below 1.0 slow down the speech, above 1.0 speed it up. Extreme values may affect quality. Default value: 1
VoiceCloningRequest#
List of audio files to use for voice cloning
remove_background_noise
 boolean
Whether to remove background noise from the audio files Default value: true
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.
TextToSpeechRequest#
text
 string
* requiredThe text to convert to speech
voice
 string
The voice to use for speech generation Default value: "Rachel"
stability
 float
Voice stability (0-1) Default value: 0.5
similarity_boost
 float
Similarity boost (0-1) Default value: 0.75
style
 float
Style exaggeration (0-1)
speed
 float
Speech speed (0.7-1.2). Values below 1.0 slow down the speech, above 1.0 speed it up. Extreme values may affect quality. Default value: 1
timestamps
 boolean
Whether to return timestamps for each word in the generated speech
previous_text
 string
The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation.
next_text
 string
The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation.
language_code
 string
Language code (ISO 639-1) used to enforce a language for the model. Currently only Turbo v2.5 and Flash v2.5 support language enforcement. For other models, an error will be returned if language code is provided.
SoundEffectRequest#
text
 string
* requiredThe text describing the sound effect to generate
duration_seconds
 float
Duration in seconds (0.5-22). If None, optimal duration will be determined from prompt.
prompt_influence
 float
How closely to follow the prompt (0-1). Higher values mean less variation. Default value: 0.3
output_format
 OutputFormatEnum
Output 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
PronunciationDictionaryLocator#
pronunciation_dictionary_id
 string
* requiredThe ID of the pronunciation dictionary.
version_id
 string
The ID of the version of the pronunciation dictionary. If not provided, the latest version will be used.
DialogueBlock#
text
 string
* requiredThe dialogue text
voice
 string
* requiredThe name or the ID of the voice to be used for the generation.
VoiceChangerRequest#
voice
 string
The voice to use for speech generation Default value: "Rachel"
audio_url
 string
* requiredThe input audio file
AudioIsolationRequest#
audio_url
 string
* requiredURL of the audio file to isolate voice from
SoundEffectRequestV2#
text
 string
* requiredThe text describing the sound effect to generate
duration_seconds
 float
Duration in seconds (0.5-22). If None, optimal duration will be determined from prompt.
prompt_influence
 float
How closely to follow the prompt (0-1). Higher values mean less variation. Default value: 0.3
output_format
 OutputFormatEnum
Output 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
loop
 boolean
Whether to create a sound effect that loops smoothly.
TranscriptionWord#
text
 string
* requiredThe transcribed word or audio event
start
 float
* requiredStart time in seconds
end
 float
* requiredEnd time in seconds
type
 string
* requiredType of element (word, spacing, or audio_event)
speaker_id
 string
Speaker identifier if diarization was enabled