Ai Face Swap | Video to Video

half-moon-ai/ai-face-swap/faceswapvideo

AI-FaceSwap-Video is a service that can replace a person's face throughout a video clip while keeping their movements natural.

Inference

Commercial use

Schema

LLMs

Playground API

About

Swap faces between source image and target video.

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("half-moon-ai/ai-face-swap/faceswapvideo", {
  input: {
    source_face_url: "https://images.pexels.com/photos/1642228/pexels-photo-1642228.jpeg",
    target_video_url: "https://videos.pexels.com/video-files/3201691/3201691-hd_1920_1080_25fps.mp4"
  },
  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("half-moon-ai/ai-face-swap/faceswapvideo", {
  input: {
    source_face_url: "https://images.pexels.com/photos/1642228/pexels-photo-1642228.jpeg",
    target_video_url: "https://videos.pexels.com/video-files/3201691/3201691-hd_1920_1080_25fps.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 { fal } from "@fal-ai/client";

const status = await fal.queue.status("half-moon-ai/ai-face-swap/faceswapvideo", {
  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("half-moon-ai/ai-face-swap/faceswapvideo", {
  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#

source_face_url string* required

Source face image. Allowed items: bmp, jpeg, png, tiff, webp

target_video_url string* required

Target video URL (max 25 minutes, will be truncated if longer; FPS capped at 25). Allowed items: avi, m4v, mkv, mp4, mpeg, mov, mxf, webm, wmv

enable_occlusion_prevention boolean

Enable occlusion prevention for handling faces covered by hands/objects. Warning: Enabling this runs an occlusion-aware model which costs 2x more.

{
  "source_face_url": "https://images.pexels.com/photos/1642228/pexels-photo-1642228.jpeg",
  "target_video_url": "https://videos.pexels.com/video-files/3201691/3201691-hd_1920_1080_25fps.mp4"
}

Output#

video Video* required

Generated video result

processing_time_ms integer

Optional processing duration in milliseconds

warning string

Warning message if video was modified (e.g., truncated or FPS reduced)

{
  "video": {
    "content_type": "video/mp4",
    "url": "https://ai-tests.angeneraltest.com/test-files/faceswapvideo.mp4"
  }
}

Other types#

FaceSwapInputImage#

source_face_url string* required

Source face image. Allowed items: bmp, jpeg, png, tiff, webp

target_image_url string* required

Target image URL. Allowed items: bmp, jpeg, png, tiff, webp

enable_occlusion_prevention boolean

Enable occlusion prevention for handling faces covered by hands/objects. Warning: Enabling this runs an occlusion-aware model which costs 2x more.

FaceFusionVideoOutputMulti#

video Video* required

Generated video result

processing_time_ms integer

Optional processing duration in milliseconds

warning string

Warning message if video was modified (e.g., truncated or FPS reduced)

FaceSwapInputVideoMulti#

source_face_url_1 string* required

First source face image (will be mapped to faces matching source_gender_1). Allowed items: bmp, jpeg, png, tiff, webp

source_gender_1 SourceGender1Enum* required

Gender of source 1 face - faces matching this gender in target will be swapped with source_face_url_1

Possible enum values: female, male

source_face_url_2 string

Second source face image (optional, will be mapped to faces matching source_gender_2). If provided, source_gender_2 must also be specified. Allowed items: bmp, jpeg, png, tiff, webp

source_gender_2 Enum

Gender of source 2 face - required when source_face_url_2 is provided. Faces matching this gender in target will be swapped with source_face_url_2 Default value: male

Possible enum values: female, male

target_video_url string* required

Target video URL (max 25 minutes, will be truncated if longer; FPS capped at 25). Allowed items: avi, m4v, mkv, mp4, mpeg, mov, mxf, webm, wmv

enable_occlusion_prevention boolean

Enable occlusion prevention for handling faces covered by hands/objects. Warning: Enabling this runs an occlusion-aware model which costs 2x more.

FaceFusionImageOutputMulti#

image Image* required

Generated image result

processing_time_ms integer

Optional processing duration in milliseconds

FaceSwapInputImageMulti#

source_face_url_1 string* required

First source face image (will be mapped to faces matching source_gender_1). Allowed items: bmp, jpeg, png, tiff, webp

source_gender_1 SourceGender1Enum* required

Gender of source 1 face - faces matching this gender in target will be swapped with source_face_url_1

Possible enum values: female, male

source_face_url_2 string

Second source face image (optional, will be mapped to faces matching source_gender_2). If provided, source_gender_2 must also be specified. Allowed items: bmp, jpeg, png, tiff, webp

source_gender_2 Enum

Gender of source 2 face - required when source_face_url_2 is provided. Faces matching this gender in target will be swapped with source_face_url_2 Default value: male

Possible enum values: female, male

target_image_url string* required

Target image URL. Allowed items: bmp, jpeg, png, tiff, webp

enable_occlusion_prevention boolean

Enable occlusion prevention for handling faces covered by hands/objects. Warning: Enabling this runs an occlusion-aware model which costs 2x more.

Video#

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.

Image#

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 image in pixels.

height integer

The height of the image in pixels.

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#

FaceSwapInputImage#

FaceFusionVideoOutputMulti#

FaceSwapInputVideoMulti#

FaceFusionImageOutputMulti#

FaceSwapInputImageMulti#

Video#

Image#

Related Models

Ai Face Swap Video to Video

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#

FaceSwapInputImage#

FaceFusionVideoOutputMulti#

FaceSwapInputVideoMulti#

FaceFusionImageOutputMulti#

FaceSwapInputImageMulti#

Video#

Image#

Related Models