Wan-Animate Replace is a model that can integrate animated characters into reference videos, replacing the original character while preserving the scene’s lighting and color tone for seamless environmental integration.

fal-ai/wan/v2.2-14b/animate/replace

Inference

Commercial use

Schema

LLMs

Playground API

fal-ai/wan/v2.2-14b/animate/replace

Schema

fal-ai/wan/v2.2-14b/animate/replace

Inference

Commercial use

Schema

LLMs

Playground API

1. Calling the API

2. Authentication

API Key

3. Queue

4. Files

5. Schema

About

Endpoint for generating a video from a video and an image with replace mode.

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. Install the new package and update your imports — see client setup.

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/wan/v2.2-14b/animate/replace", {
  input: {
    video_url: "https://v3b.fal.media/files/b/panda/a6SvJg96V8eoglMlYFShU_5385885-hd_1080_1920_25fps.mp4",
    image_url: "https://v3b.fal.media/files/b/panda/-oMlZo9Yyj_Nzoza_tgds_GmLF86r5bOt50eMMKCszy_eacc949b3933443c9915a83c98fbe85e.png"
  },
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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("fal-ai/wan/v2.2-14b/animate/replace", {
  input: {
    video_url: "https://v3b.fal.media/files/b/panda/a6SvJg96V8eoglMlYFShU_5385885-hd_1080_1920_25fps.mp4",
    image_url: "https://v3b.fal.media/files/b/panda/-oMlZo9Yyj_Nzoza_tgds_GmLF86r5bOt50eMMKCszy_eacc949b3933443c9915a83c98fbe85e.png"
  },
  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/wan/v2.2-14b/animate/replace", {
  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/wan/v2.2-14b/animate/replace", {
  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#

video_url string* required

URL of the input video.

image_url string* required

URL of the input image. If the input image does not match the chosen aspect ratio, it is resized and center cropped.

guidance_scale float

Classifier-free guidance scale. Higher values give better adherence to the prompt but may decrease quality. Default value: 1

resolution ResolutionEnum

Resolution of the generated video (480p, 580p, or 720p). Default value: "480p"

Possible enum values: 480p, 580p, 720p

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

num_inference_steps integer

Number of inference steps for sampling. Higher values give better quality but take longer. Default value: 20

enable_safety_checker boolean

If set to true, input data will be checked for safety before processing. Disabling it requires account authorization; unauthorized requests are always checked.

enable_output_safety_checker boolean

If set to true, output video will be checked for safety after generation.

shift float

Shift value for the video. Must be between 1.0 and 10.0. Default value: 5

video_quality VideoQualityEnum

The quality of the output video. Higher quality means better visual quality but larger file size. Default value: "high"

Possible enum values: low, medium, high, maximum

video_write_mode VideoWriteModeEnum

The write mode of the output video. Faster write mode means faster results but larger file size, balanced write mode is a good compromise between speed and quality, and small write mode is the slowest but produces the smallest file size. Default value: "balanced"

Possible enum values: fast, balanced, small

return_frames_zip boolean

If true, also return a ZIP archive containing per-frame images generated on GPU (lossless).

use_turbo boolean

If true, applies quality enhancement for faster generation with improved quality. When enabled, parameters are automatically optimized for best results.

{
  "video_url": "https://v3b.fal.media/files/b/panda/a6SvJg96V8eoglMlYFShU_5385885-hd_1080_1920_25fps.mp4",
  "image_url": "https://v3b.fal.media/files/b/panda/-oMlZo9Yyj_Nzoza_tgds_GmLF86r5bOt50eMMKCszy_eacc949b3933443c9915a83c98fbe85e.png",
  "guidance_scale": 1,
  "resolution": "480p",
  "num_inference_steps": 6,
  "enable_safety_checker": true,
  "enable_output_safety_checker": false,
  "shift": 8,
  "video_quality": "high",
  "video_write_mode": "balanced",
  "use_turbo": true
}

Output#

video File* required

The generated video file.

frames_zip File

ZIP archive of generated frames (if requested).

prompt string* required

The prompt used for generation (auto-generated by the model)

seed integer* required

The seed used for generation

{
  "video": {
    "url": "https://v3b.fal.media/files/b/elephant/9Ofgiju3Peb3b5hriTuBH_wan_animate_output.mp4"
  },
  "prompt": "",
  "seed": 1416721728
}

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.

Related Models

1. Calling the API

2. Authentication

API Key

3. Queue

4. Files

5. Schema

About

Endpoint for generating a video from a video and an image with replace mode.

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. Install the new package and update your imports — see client setup.

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/wan/v2.2-14b/animate/replace", {
  input: {
    video_url: "https://v3b.fal.media/files/b/panda/a6SvJg96V8eoglMlYFShU_5385885-hd_1080_1920_25fps.mp4",
    image_url: "https://v3b.fal.media/files/b/panda/-oMlZo9Yyj_Nzoza_tgds_GmLF86r5bOt50eMMKCszy_eacc949b3933443c9915a83c98fbe85e.png"
  },
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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

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

Protect your API Key

3. Queue#

Long-running requests

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/wan/v2.2-14b/animate/replace", {
  input: {
    video_url: "https://v3b.fal.media/files/b/panda/a6SvJg96V8eoglMlYFShU_5385885-hd_1080_1920_25fps.mp4",
    image_url: "https://v3b.fal.media/files/b/panda/-oMlZo9Yyj_Nzoza_tgds_GmLF86r5bOt50eMMKCszy_eacc949b3933443c9915a83c98fbe85e.png"
  },
  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/wan/v2.2-14b/animate/replace", {
  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/wan/v2.2-14b/animate/replace", {
  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)#

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#

video_url string* required

URL of the input video.

image_url string* required

URL of the input image. If the input image does not match the chosen aspect ratio, it is resized and center cropped.

guidance_scale float

Classifier-free guidance scale. Higher values give better adherence to the prompt but may decrease quality. Default value: 1

resolution ResolutionEnum

Resolution of the generated video (480p, 580p, or 720p). Default value: "480p"

Possible enum values: 480p, 580p, 720p

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

num_inference_steps integer

Number of inference steps for sampling. Higher values give better quality but take longer. Default value: 20

enable_safety_checker boolean

If set to true, input data will be checked for safety before processing. Disabling it requires account authorization; unauthorized requests are always checked.

enable_output_safety_checker boolean

If set to true, output video will be checked for safety after generation.

shift float

Shift value for the video. Must be between 1.0 and 10.0. Default value: 5

video_quality VideoQualityEnum

The quality of the output video. Higher quality means better visual quality but larger file size. Default value: "high"

Possible enum values: low, medium, high, maximum

video_write_mode VideoWriteModeEnum

Possible enum values: fast, balanced, small

return_frames_zip boolean

If true, also return a ZIP archive containing per-frame images generated on GPU (lossless).

use_turbo boolean

If true, applies quality enhancement for faster generation with improved quality. When enabled, parameters are automatically optimized for best results.

{
  "video_url": "https://v3b.fal.media/files/b/panda/a6SvJg96V8eoglMlYFShU_5385885-hd_1080_1920_25fps.mp4",
  "image_url": "https://v3b.fal.media/files/b/panda/-oMlZo9Yyj_Nzoza_tgds_GmLF86r5bOt50eMMKCszy_eacc949b3933443c9915a83c98fbe85e.png",
  "guidance_scale": 1,
  "resolution": "480p",
  "num_inference_steps": 6,
  "enable_safety_checker": true,
  "enable_output_safety_checker": false,
  "shift": 8,
  "video_quality": "high",
  "video_write_mode": "balanced",
  "use_turbo": true
}

Output#

video File* required

The generated video file.

frames_zip File

ZIP archive of generated frames (if requested).

prompt string* required

The prompt used for generation (auto-generated by the model)

seed integer* required

The seed used for generation

{
  "video": {
    "url": "https://v3b.fal.media/files/b/elephant/9Ofgiju3Peb3b5hriTuBH_wan_animate_output.mp4"
  },
  "prompt": "",
  "seed": 1416721728
}

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.

fal-ai/wan/v2.2-14b/animate/replace

Table of contents

Table of contents

fal-ai/wan/v2.2-14b/animate/replace

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#

File#

Related Models

Table of contents

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#

File#

Related Models