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/hunyuan-avatar", {
input: {
audio_url: "https://v3.fal.media/files/koala/80RpP2FOhXZUV3NRKUWZu_2.WAV",
image_url: "https://storage.googleapis.com/falserverless/example_inputs/girl.jpg"
},
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("fal-ai/hunyuan-avatar", {
input: {
audio_url: "https://v3.fal.media/files/koala/80RpP2FOhXZUV3NRKUWZu_2.WAV",
image_url: "https://storage.googleapis.com/falserverless/example_inputs/girl.jpg"
},
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/hunyuan-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/hunyuan-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.
audio_url string* requiredThe URL of the audio file.
image_url string* requiredThe URL of the reference image.
text stringText prompt describing the scene. Default value: "A cat is singing."
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
num_frames integerNumber of video frames to generate at 25 FPS. If greater than the input audio length, it will capped to the length of the input audio. Default value: 129
num_inference_steps integerNumber of inference steps for sampling. Higher values give better quality but take longer. Default value: 30
turbo_mode booleanIf true, the video will be generated faster with no noticeable degradation in the visual quality. Default value: true
seed integerRandom seed for generation.
{
"audio_url": "https://v3.fal.media/files/koala/80RpP2FOhXZUV3NRKUWZu_2.WAV",
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/girl.jpg",
"text": "A cat is singing.",
"enable_safety_checker": true,
"num_frames": 129,
"num_inference_steps": 30,
"turbo_mode": true
}The generated video with the avatar animation.
{
"video": {
"file_name": "output_with_audio.mp4",
"url": "https://v3.fal.media/files/monkey/3ODbdqHHQL3SvgRXEJXQ-_hunava_8333d613-d4e3-42ff-be36-1e97775621ba_audio.mp4",
"file_size": 1646349,
"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.