Create a talking-avatar video from text.
{
"script": "Welcome! Here is what I want to share with you today.",
"avatar": "Jasmine"
}Video and audio references are a pair: if either one is supplied, both are required. A complete pair replaces the Avatar entirely. The Script still supplies the spoken words.
{
"script": "Welcome! Here is what I want to share with you today.",
"avatar": "None",
"video_reference_url": "https://example.com/reference.mp4",
"audio_reference_url": "https://example.com/voice-reference.wav"
}.mp3, .wav, .aif, .aiff, .aifc, .m4a, .mp4,
.aac, .ogg, .oga, .opus, .webm, .weba, .flac.mp4, .mov, .m4v, .webmIf an audio file type is not offered in the upload picker, paste a public HTTPS URL instead.
Scripts must contain 50-1,500 characters. The minimum typically produces about four seconds of speech. Voice references must be 10-180 seconds; only the first 60 seconds are used. Generated speech must be 180 seconds or shorter.
The result is one lip-synced MP4 video.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set 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("mirage-api/avatar-x/text-to-video", {
input: {
script: "Put in a script, and Mirage Avatar X turns it into a clear, expressive video. Let’s bring your next idea to life."
},
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"
});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.
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("mirage-api/avatar-x/text-to-video", {
input: {
script: "Put in a script, and Mirage Avatar X turns it into a clear, expressive video. Let’s bring your next idea to life."
},
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("mirage-api/avatar-x/text-to-video", {
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("mirage-api/avatar-x/text-to-video", {
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);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.
script string* requiredUse 50 to 1,500 characters. The 50-character minimum typically produces about four seconds of speech. Generated speech must be 180 seconds or shorter; speaking pace may cause shorter scripts to exceed this limit.
avatar EnumStock visual and voice. Browse the avatar catalog to preview every available avatar and copy the exact Avatar value. Select None to send no avatar. When video_reference_url and audio_reference_url are both supplied, the references replace the avatar entirely and it may be omitted. Default value: Jasmine
Possible enum values: None, Ayesha, Ayesha (16:9), Farhan, Farhan (16:9), Giulia, Giulia (16:9), Jasmine, Jasmine (16:9), Luke, Luke (16:9), Maya, Maya (16:9), Michael, Michael (16:9), Neha, Neha (16:9), Tariq, Tariq (16:9), Valerie, Valerie (16:9)
video_reference_url stringPublicly fetchable HTTPS URL of a reference video. When supplied, audio_reference_url is also required and the selected avatar is ignored; no cookies or authorization headers. Supports H.264, H.265/HEVC, or ProRes in .mp4, .mov, or .m4v and VP8 or VP9 in .webm, from 1 to 120 seconds and up to 1 GiB, with a 9:16 or 16:9 display aspect ratio (within 5%). Any audio track is ignored.
audio_reference_url stringPublicly fetchable HTTPS URL of a voice reference. When supplied, video_reference_url is also required and the selected avatar is ignored; no cookies or authorization headers. Supports MP3, PCM WAV or AIFF, AAC or ALAC, Opus or Vorbis, and FLAC audio from 10 to 180 seconds and up to 64 MiB, with one mono or stereo stream sampled from 8 to 48 kHz. Only the first 60 seconds are used.
{
"script": "Put in a script, and Mirage Avatar X turns it into a clear, expressive video. Let’s bring your next idea to life.",
"avatar": "Jasmine"
}{
"video": {
"file_name": "mirage-avatar-x-jasmine-text-to-video-demo.mp4",
"file_size": 7338484,
"url": "https://v3b.fal.media/files/b/0aa596e6/n-l_tkXZNWU4rdTylTkMX_mirage-avatar-x-jasmine-text-to-video-demo.mp4",
"content_type": "video/mp4"
}
}cancelled boolean* requiredreason EnumPossible enum values: missing_or_invalid_request_id, request_not_active, delivery_already_committed
message string* requiredurl 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.