About
Lip Sync Image To 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/clientMigrate to @fal-ai/client
The @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.
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("minimax/h3-max/lip-sync/image-to-video", {
input: {
image_url: "",
audio_url: ""
},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});Protect your API 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.
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("minimax/h3-max/lip-sync/image-to-video", {
input: {
image_url: "",
audio_url: ""
},
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("minimax/h3-max/lip-sync/image-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("minimax/h3-max/lip-sync/image-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);Auto uploads
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.
5. Schema#
Input#
image_url string* requiredImage to animate. The aspect ratio must be between 0.4 and 2.5.
audio_url string* requiredAudio to synchronize the mouth movements to, at least 5 seconds long. Audio over 15 seconds is automatically clipped to its first 15 seconds. The output video matches the clipped audio duration in a single generation.
resolution ResolutionEnumOutput resolution. Uses the supported aspect ratio nearest the image. Default value: "768P"
Possible enum values: 480P, 768P, 1080P, 2K
enable_transcription booleanTranscribe the supplied audio to guide lip synchronization. When disabled, synchronize to the audio without a transcript. Default value: true
seed integerRandom seed; selected randomly if omitted.
enable_safety_checker booleanEnable content safety checks. Default value: true
{
"image_url": "",
"audio_url": "",
"resolution": "768P",
"enable_transcription": true,
"enable_safety_checker": true
}Output#
Lip-synced video with the supplied soundtrack.
seed integer* requiredRandom seed used for generation.
duration float* requiredOutput duration in seconds.
{
"video": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}Other types#
TranscriptSegment#
start float* requiredSpeech start in source-video seconds.
end float* requiredSpeech end in source-video seconds.
text string* requiredSource text, or final dialogue when auto_translate is false.
File#
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.
DubbingSegment#
start float* requiredend float* requiredtext string* requiredtranslated_text string* requiredAVCheckpoint#
url string* requiredUnguesseable service-issued checkpoint artifact URL.
sha256 string* requiredsize_bytes integer* requiredversion integerDefault value: 1
model stringDefault value: "minimax-h3"
transformer_family TransformerFamilyEnumDefault value: "fl2va"
Possible enum values: fl2va, ref2va, ref2va-tdm-k10
resolution ResolutionEnum* requiredPossible enum values: 480p, 544p, 640p, 704p, 768p, 1080p, 1440p
checkpoint_id string* requiredowner_id string* requiredsha256 of the issuing caller's gateway identity.
source_request_id string* requiredIssuing request id — audit/provenance lineage only.
issued_at integer* requiredexpires_at integer* requiredaudience stringDefault value: "minimax-h3/continue-video"
signature string* requiredService HMAC binding the complete descriptor.
CheckpointLoRA#
locator string* requiredOpaque service-owned adapter locator.
sha256 string* requiredsize_bytes integer* requiredscale float* requiredtransformer_family TransformerFamilyEnum* requiredPossible enum values: fl2va, ref2va, ref2va-tdm-k10
transformer_variant string* requiredH3MaxCameraKeyframe#
time float* requiredNormalized video time, from 0 at the start to 1 at the end.
azimuth float* requiredHorizontal camera angle around the subject, in degrees.
elevation float* requiredVertical camera angle around the subject, in degrees.
distance float* requiredCamera distance from the subject in normalized scene units.