Try Seedance 2.5 in fal Agent
Docs
Log-inSign-up

mirage-api/avatar-x/text-to-video

The Avatar X API offers access to Mirage's most advanced generation model yet, delivering industry-leading identity preservation and expressivity in AI video
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

Table of contents

About

Create a talking-avatar video from text.

Quick start

  1. Enter what you want the avatar to say in Script.
  2. Use Jasmine, which is selected initially, or choose another Avatar.
  3. Select Run.
{
"script": "Welcome! Here is what I want to share with you today.",
"avatar": "Jasmine"
}

Use your own visual and voice

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

Supported reference URL file types

  • Voice audio: .mp3, .wav, .aif, .aiff, .aifc, .m4a, .mp4, .aac, .ogg, .oga, .opus, .webm, .weba, .flac
  • Video: .mp4, .mov, .m4v, .webm

If 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.

Common mistakes

  • A video reference and an audio reference must be supplied together.
  • When both references are supplied, Avatar is ignored.
  • None sends no avatar. When both references are omitted, choose a stock Avatar.
  • Audio reference is a voice sample, not the words to perform; Script supplies the words.
  • A video reference's audio track is ignored.
  • URL inputs must be public HTTPS URLs that work without cookies or request headers.

The result is one lip-synced MP4 video.

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("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);

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("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",
});

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("mirage-api/avatar-x/text-to-video", {
  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("mirage-api/avatar-x/text-to-video", {
  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

Use 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 Enum

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

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

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

Output#

video Video* required
{
  "video": {
    "url": "https://v3b.fal.media/files/b/0aa596e6/n-l_tkXZNWU4rdTylTkMX_mirage-avatar-x-jasmine-text-to-video-demo.mp4",
    "content_type": "video/mp4",
    "file_name": "mirage-avatar-x-jasmine-text-to-video-demo.mp4",
    "file_size": 7338484
  }
}

Other types#

Video#

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