# fal-ai/live-portrait

## Video

Transfer expression from a video to a portrait.

## Inference

Commercial use

### Table of contents

- ## 1. Calling the API
  - Install the client
  - Setup your API Key
  - Submit a request
- ## 2. Authentication
  - API Key
- ## 3. Queue
  - Submit a request
  - Fetch request status
  - Get the result
- ## 4. Files
  - Data URI (base64)
  - Hosted files (URL)
  - Uploading files
- ## 5. Schema
  - Input
  - Output
  - Other

## About

Predict Pose

### 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
```

### 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/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);
    }
  },
});
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.

## 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/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"
  },
  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/live-portrait", {
  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](/content/models/fal-ai/live-portrait/api#schema-output/index.html) for the expected result format.

```
import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/live-portrait", {
  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.

### 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);
```

## 5. Schema

### Input

`video_url`

string required

URL of the video to drive the lip syncing.

`image_url`

string required

URL of the image to be animated

`blink`

float

Amount to blink the eyes

`eyebrow`

float

Amount to raise or lower eyebrows

`wink`

float

Amount to wink

`pupil_x`

float

Amount to move pupils horizontally

`pupil_y`

float

Amount to move pupils vertically

`aaa`

float

Amount to open mouth in 'aaa' shape

`eee`

float

Amount to shape mouth in 'eee' position

`woo`

float

Amount to shape mouth in 'woo' position

`smile`

float

Amount to smile

`flag_lip_zero`

boolean

Whether to set the lip to closed state before animation.

### Output

`video`

File required

The generated video file.

### Other types

#### File

`url`

string required

The URL where the file can be downloaded from.

`content_type`

string

The mime type of the file.