Loading API documentation
Heygen Photo Avatar 4 Model
fal-ai/heygen/avatar4/image-to-video
Heygen Photo Avatar 4 Model
Inference
Commercial use
Partner
Loading API documentation
Generate a video from a photo using HeyGen Avatar 4.
Upload an image with a clear face and provide text for the avatar to speak. Billed per second of output video ($0.1000/s).
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/heygen/avatar4/image-to-video", {
input: {
image_url: "https://v3b.fal.media/files/b/0a90062c/A7EIviZqNxZ2HAs0yHeZ6_77a05b99-8588-4ffc-90aa-be7f9d34e9d3.png"
},
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/heygen/avatar4/image-to-video", {
input: {
image_url: "https://v3b.fal.media/files/b/0a90062c/A7EIviZqNxZ2HAs0yHeZ6_77a05b99-8588-4ffc-90aa-be7f9d34e9d3.png"
},
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/heygen/avatar4/image-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("fal-ai/heygen/avatar4/image-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.
image_url string* requiredURL of the image to animate. The image should contain a clear face.
prompt stringThe text the avatar will speak
voice stringName of the voice to use for the avatar
audio_url stringURL of an audio file for the avatar to lip-sync to. When provided, overrides prompt and voice.
talking_style TalkingStyleEnumTalking style - 'stable' for minimal movement, 'expressive' for more animation Default value: "stable"
Possible enum values: stable, expressive
expression stringFacial expression
Background configuration
resolution ResolutionEnumVideo resolution preset. Options: 360p, 480p, 540p, 720p, 1080p Default value: "720p"
Possible enum values: 360p, 480p, 540p, 720p, 1080p
aspect_ratio AspectRatioEnumAspect ratio of the output video. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', and 'auto'. 'auto' preserves the source aspect ratio when HeyGen can read it, falling back to '16:9' otherwise. Default value: "16:9"
Possible enum values: 16:9, 9:16, 4:5, 5:4, 1:1, auto
caption booleanWhether to add captions to the video
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"image_url": "https://v3b.fal.media/files/b/0a90062c/A7EIviZqNxZ2HAs0yHeZ6_77a05b99-8588-4ffc-90aa-be7f9d34e9d3.png",
"prompt": "Hey friends! Welcome to the GPU force podcast and today we are going to discuss about the rising GPU cost!",
"voice": "Melissa",
"talking_style": "stable",
"resolution": "720p",
"aspect_ratio": "16:9",
"enable_safety_checker": true
}The generated video file
{
"video": {
"file_name": "output.mp4",
"url": "https://v3b.fal.media/files/b/0a900636/DUES0_z4i7FWnife02ieH_output.mp4",
"file_size": 2466524,
"content_type": "video/mp4"
}
}type TypeEnumType of background Default value: "color"
Possible enum values: color, image, video
value stringBackground value - hex color for 'color' type, URL for 'image' or 'video' type Default value: "#FFFFFF"
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.