Live Portrait

fal-ai/live-portrait
Inference
Research only

1. Calling the API#

Install the client#

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

npm install --save @fal-ai/serverless-client

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 * as fal from "@fal-ai/serverless-client";

const result = await fal.subscribe("fal-ai/live-portrait", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/model_tests/live-portrait/liveportrait-example.mp4",
    image_url: "https://storage.googleapis.com/falserverless/model_tests/live-portrait/XKEmk3mAzGHUjK3qqH-UL.jpeg"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});

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 * as fal from "@fal-ai/serverless-client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. 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 * as fal from "@fal-ai/serverless-client";

// Upload a file (you can get a file reference from an input element or a drag-and-drop event)
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

// Use the URL in your request
const result = await fal.subscribe("fal-ai/live-portrait", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

video_url*string

URL of the video to drive the lip syncing.

image_url*string

URL of the image to be animated

flag_lip_zeroboolean

Whether to set the lip to closed state before animation. Only takes effect when flag_eye_retargeting and flag_lip_retargeting are False. Default value: true

flag_eye_retargetingboolean

Whether to enable eye retargeting.

flag_lip_retargetingboolean

Whether to enable lip retargeting.

flag_stitchingboolean

Whether to enable stitching. Recommended to set to True. Default value: true

flag_relativeboolean

Whether to use relative motion. Default value: true

flag_pastebackboolean

Whether to paste-back/stitch the animated face cropping from the face-cropping space to the original image space. Default value: true

flag_do_cropboolean

Whether to crop the source portrait to the face-cropping space. Default value: true

flag_do_rotboolean

Whether to conduct the rotation when flag_do_crop is True. Default value: true

dsizeinteger

Size of the output image. Default value: 512

scalefloat

Scaling factor for the face crop. Default value: 2.3

vx_ratiofloat

Horizontal offset ratio for face crop.

vy_ratiofloat

Vertical offset ratio for face crop. Positive values move up, negative values move down. Default value: -0.125

{
  "video_url": "https://storage.googleapis.com/falserverless/model_tests/live-portrait/liveportrait-example.mp4",
  "image_url": "https://storage.googleapis.com/falserverless/model_tests/live-portrait/XKEmk3mAzGHUjK3qqH-UL.jpeg",
  "flag_lip_zero": true,
  "flag_stitching": true,
  "flag_relative": true,
  "flag_pasteback": true,
  "flag_do_crop": true,
  "flag_do_rot": true,
  "dsize": 512,
  "scale": 2.3,
  "vy_ratio": -0.125
}

Output#

video*File

The generated video file.

{
  "video": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019
  }
}