fal-ai/sync-lipsync/v3

sync-3 most powerful lipsync model yet, featuring native visual intelligence for professional-quality video.

Inference

Commercial use

Partner

Schema

LLMs

Playground API Examples

About

Lipsync Request V3

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

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("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);

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#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.

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#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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("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",
});

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("fal-ai/sync-lipsync/v3", {
  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("fal-ai/sync-lipsync/v3", {
  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#

video_url string* required

URL of the input video

audio_url string* required

URL of the input audio

sync_mode SyncModeEnum

Lipsync mode when audio and video durations are out of sync. Default value: "cut_off"

Possible enum values: cut_off, loop, bounce, silence, remap

options Sync3GenerationOptions

Additional Sync.so generation options. If options.sync_mode is set, it overrides the top-level sync_mode field.

{
  "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"
}

Output#

video File* required

The generated video

{
  "video": {
    "url": "https://v3b.fal.media/files/b/0a93c312/TqKMiLtCcTKWSeAWXJRD0_output.mp4"
  }
}

Other types#

Sync3GenerationOptions#

sync_mode Enum

Defines 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 Enum

Edit 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 Enum

Emotion prompt for generation. This is a Sync.so option primarily used by react-1.

Possible enum values: happy, sad, angry, disgusted, surprised, neutral

temperature float

Controls 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 Sync3ActiveSpeakerDetection

Active speaker detection configuration for videos with multiple people.

occlusion_detection_enabled boolean

Whether to detect occlusion during generation. Sync.so handles this automatically for sync-3, so this option is ignored by sync-3.

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

Sync3ActiveSpeakerDetection#

auto_detect boolean

Whether to automatically detect and apply generation to the active speaker.

v3 boolean

Whether to use Sync.so's active speaker detection v3.

use_v2 boolean

Deprecated Sync.so option for active speaker detection v2.

frame_number integer

Frame index for manual speaker selection coordinates.

coordinates list<integer>

Reference point [x, y] on the speaker's face in frame_number.

bounding_boxes list<list<integer>>

Per-frame bounding boxes [x1, y1, x2, y2] for the detected face.

bounding_boxes_url string

URL to a JSON file containing per-frame bounding boxes.

face_image string

Base64 encoded face image for manual speaker selection.

VideoFile#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

width integer

The width of the video

height integer

The height of the video

fps float

The FPS of the video

duration float

The duration of the video

num_frames integer

The number of frames in the video

fal-ai/sync-lipsync/v3

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

Sync3GenerationOptions#

File#

Sync3ActiveSpeakerDetection#

VideoFile#