Loading API documentation
Lipsync Request V3
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/sync-lipsync/v3", {
input: {
video_url: "https://v3.fal.media/files/tiger/IugLCDJRIoGqvqTa-EJTr_3wg74vCqyNuQ-IiBd77MM_output.mp4",
audio_url: "https://fal.media/files/lion/vyFWygmZsIZlUO4s0nr2n.wav"
},
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/sync-lipsync/v3", {
input: {
video_url: "https://v3.fal.media/files/tiger/IugLCDJRIoGqvqTa-EJTr_3wg74vCqyNuQ-IiBd77MM_output.mp4",
audio_url: "https://fal.media/files/lion/vyFWygmZsIZlUO4s0nr2n.wav"
},
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/sync-lipsync/v3", {
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/sync-lipsync/v3", {
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.
enable_safety_checker booleanDefault value: true
video_url string* requiredURL of the input video
audio_url string* requiredURL of the input audio
sync_mode SyncModeEnumLipsync mode when audio and video durations are out of sync. Default value: "cut_off"
Possible enum values: cut_off, loop, bounce, silence, remap
Additional Sync.so generation options. If options.sync_mode is set, it overrides the top-level sync_mode field.
{
"enable_safety_checker": true,
"video_url": "https://v3.fal.media/files/tiger/IugLCDJRIoGqvqTa-EJTr_3wg74vCqyNuQ-IiBd77MM_output.mp4",
"audio_url": "https://fal.media/files/lion/vyFWygmZsIZlUO4s0nr2n.wav",
"sync_mode": "cut_off"
}The generated video
{
"video": {
"url": "https://v3b.fal.media/files/b/0a93c312/TqKMiLtCcTKWSeAWXJRD0_output.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.
sync_mode EnumDefines how to handle duration mismatches between video and audio inputs. Overrides the top-level sync_mode when provided.
Possible enum values: cut_off, loop, bounce, silence, remap
model_mode EnumEdit region for the model. This is a Sync.so option primarily used by react-1.
Possible enum values: lips, face, head, lipsync, emotion, talking_head
prompt EnumEmotion prompt for generation. This is a Sync.so option primarily used by react-1.
Possible enum values: happy, sad, angry, disgusted, surprised, neutral
temperature floatControls how expressive lipsync can be; 0 is least expressive, 1 is most expressive. Sync.so handles this natively for sync-3, so this option is ignored by sync-3.
Active speaker detection configuration for videos with multiple people.
occlusion_detection_enabled booleanWhether to detect occlusion during generation. Sync.so handles this automatically for sync-3, so this option is ignored by sync-3.
auto_detect booleanWhether to automatically detect and apply generation to the active speaker.
v3 booleanWhether to use Sync.so's active speaker detection v3.
use_v2 booleanDeprecated Sync.so option for active speaker detection v2.
frame_number integerFrame index for manual speaker selection coordinates.
Reference point [x, y] on the speaker's face in frame_number.
Per-frame bounding boxes [x1, y1, x2, y2] for the detected face.
bounding_boxes_url stringURL to a JSON file containing per-frame bounding boxes.
face_image stringBase64 encoded face image for manual speaker selection.