Wav2Lip Video to Video
About
Run Wav2Lip On Fal
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/wav2lip", {
input: {
face_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("fal-ai/wav2lip", {
input: {
face_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("fal-ai/wav2lip", {
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/wav2lip", {
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#
face_url
string
* requiredUrl to video/image with face to use
audio_url
string
* requiredUrl of video/audio to use as audio source
static
boolean
If True, then use only first video frame for inference
fps
float
Can be specified only if input is a static image (default: 25) Default value: 25
Padding (top, bottom, left, right). Please adjust to include chin at least Default value: 0,10,0,0
face_det_batch_size
integer
Batch size for face detection Default value: 16
wav2lip_batch_size
integer
Batch size for Wav2Lip model(s) Default value: 128
resize_factor
integer
Reduce the resolution by this factor. Sometimes, best results are obtained at 480p or 720p Default value: 1
Crop video to a smaller region (top, bottom, left, right). Applied after resize_factor and rotate arg. Useful if multiple faces present. -1 implies the value will be auto-inferred based on height, width Default value: 0,-1,0,-1
Specify a constant bounding box for the face. Use only as a last resort if the face is not detected. Also, might work only if the face is not moving around much. Syntax: (top, bottom, left, right). Default value: -1,-1,-1,-1
rotate
boolean
Sometimes videos taken from a phone can be flipped 90deg. If true, will flip video right by 90deg. Use if you get a flipped result, despite feeding a normal looking video
nosmooth
boolean
Prevent smoothing face detections over a short temporal window
{
"face_url": "",
"audio_url": "",
"fps": 25,
"pads": [
0,
10,
0,
0
],
"face_det_batch_size": 16,
"wav2lip_batch_size": 128,
"resize_factor": 1,
"crop": [
0,
-1,
0,
-1
],
"box": [
-1,
-1,
-1,
-1
]
}
Output#
{
"video": {
"url": "https://url.to/generated/file/z9RV14K95DvU.png",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}
Other types#
File#
url
string
* requiredThe URL where the file can be downloaded from.
content_type
string
* requiredThe mime type of the file.
file_name
string
* requiredThe name of the file. It will be auto-generated if not provided.
file_size
integer
* requiredThe size of the file in bytes.