Loading API documentation
This model is no longer supported.
This model is no longer supported.
Generate
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("fal-ai/live-avatar", {
input: {
image_url: "https://v3b.fal.media/files/b/0a86b14d/NzJ8cpbwpOJPEX8SMpqe4_cyclops_baker.jpg",
audio_url: "https://v3b.fal.media/files/b/0a86b1d1/iHOKR5dlnHWW9UFfgL90b_tmp9fq30v29.wav",
prompt: "A person speaking naturally with expressive gestures."
},
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("fal-ai/live-avatar", {
input: {
image_url: "https://v3b.fal.media/files/b/0a86b14d/NzJ8cpbwpOJPEX8SMpqe4_cyclops_baker.jpg",
audio_url: "https://v3b.fal.media/files/b/0a86b1d1/iHOKR5dlnHWW9UFfgL90b_tmp9fq30v29.wav",
prompt: "A person speaking naturally with expressive gestures."
}
});
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"
});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("fal-ai/live-avatar", {
input: {
image_url: "https://v3b.fal.media/files/b/0a86b14d/NzJ8cpbwpOJPEX8SMpqe4_cyclops_baker.jpg",
audio_url: "https://v3b.fal.media/files/b/0a86b1d1/iHOKR5dlnHWW9UFfgL90b_tmp9fq30v29.wav",
prompt: "A person speaking naturally with expressive gestures."
},
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("fal-ai/live-avatar", {
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("fal-ai/live-avatar", {
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.
image_url string* requiredThe URL of the reference image for avatar generation. The character in this image will be animated.
audio_url string* requiredThe URL of the driving audio file (WAV or MP3). The avatar will be animated to match this audio.
prompt string* requiredA text prompt describing the scene and character. Helps guide the video generation style and context.
num_clips integerNumber of video clips to generate. Each clip is approximately 3 seconds. Set higher for longer videos. Default value: 10
frames_per_clip integerNumber of frames per clip. Must be a multiple of 4. Higher values = smoother but slower generation. Default value: 48
guidance_scale floatClassifier-free guidance scale. Higher values follow the prompt more closely.
seed integerRandom seed for reproducible generation.
enable_safety_checker booleanEnable safety checker for content moderation. Default value: true
acceleration AccelerationEnumAcceleration level for faster video decoding Default value: "none"
Possible enum values: none, light, regular, high
{
"image_url": "https://v3b.fal.media/files/b/0a86b14d/NzJ8cpbwpOJPEX8SMpqe4_cyclops_baker.jpg",
"audio_url": "https://v3b.fal.media/files/b/0a86b1d1/iHOKR5dlnHWW9UFfgL90b_tmp9fq30v29.wav",
"prompt": "A person speaking naturally with expressive gestures.",
"num_clips": 10,
"frames_per_clip": 48,
"enable_safety_checker": true,
"acceleration": "none"
}The generated avatar video file with synchronized audio.
seed integer* requiredThe seed used for generation.
{
"video": {
"url": "https://v3b.fal.media/files/b/0a86b1d5/tLG1qOjdIYYhJSqJGEMWs_output.mp4",
"content_type": "video/mp4"
}
}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.
width integerThe width of the video
height integerThe height of the video
fps floatThe FPS of the video
duration floatThe duration of the video
num_frames integerThe number of frames in the video