StatusDocsPricingCommunity
Log-inSign-up

Sad Talker

fal-ai/sadtalker/reference
Inference
Commercial use

About

Generate Video W Reference

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/sadtalker/reference", {
  input: {
    source_image_url: "https://storage.googleapis.com/falserverless/model_tests/sadtalker/anime_girl.png",
    driven_audio_url: "https://storage.googleapis.com/falserverless/model_tests/sadtalker/deyu.wav",
    reference_pose_video_url: "https://github.com/OpenTalker/SadTalker/raw/main/examples/ref_video/WDA_AlexandriaOcasioCortez_000.mp4"
  },
  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. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import * as fal from "@fal-ai/serverless-client";

const { request_id } = await fal.queue.submit("fal-ai/sadtalker/reference", {
  input: {
    source_image_url: "https://storage.googleapis.com/falserverless/model_tests/sadtalker/anime_girl.png",
    driven_audio_url: "https://storage.googleapis.com/falserverless/model_tests/sadtalker/deyu.wav",
    reference_pose_video_url: "https://github.com/OpenTalker/SadTalker/raw/main/examples/ref_video/WDA_AlexandriaOcasioCortez_000.mp4"
  },
  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 * as fal from "@fal-ai/serverless-client";

const status = await fal.queue.status("fal-ai/sadtalker/reference", {
  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 * as fal from "@fal-ai/serverless-client";

const result = await fal.queue.result("fal-ai/sadtalker/reference", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});

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

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

source_image_url string* required

URL of the source image

driven_audio_url string* required

URL of the driven audio

reference_pose_video_url string* required

URL of the reference video

pose_style integer

The style of the pose

face_model_resolution FaceModelResolutionEnum

The resolution of the face model Default value: "256"

Possible enum values: 256, 512

expression_scale float

The scale of the expression Default value: 1

face_enhancer FaceEnhancerEnum

The type of face enhancer to use

Possible enum values: gfpgan

still_mode boolean

Whether to use still mode. Fewer head motion, works with preprocess full.

preprocess PreprocessEnum

The type of preprocessing to use Default value: "crop"

Possible enum values: crop, extcrop, resize, full, extfull

{
  "source_image_url": "https://storage.googleapis.com/falserverless/model_tests/sadtalker/anime_girl.png",
  "driven_audio_url": "https://storage.googleapis.com/falserverless/model_tests/sadtalker/deyu.wav",
  "reference_pose_video_url": "https://github.com/OpenTalker/SadTalker/raw/main/examples/ref_video/WDA_AlexandriaOcasioCortez_000.mp4",
  "face_model_resolution": "256",
  "expression_scale": 1,
  "face_enhancer": null,
  "preprocess": "crop"
}

Output#

video File* required

URL of the generated video

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

Other types#

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.