Wan-2.2 Text-to-Video | Text to Video

fal-ai/wan-22

Wan-2.2 is a text-to-video model that generates high-quality videos with high visual quality and motion diversity from text prompts

Inference

Commercial use

Schema

LLMs

Playground API

About

Endpoint for inpainting a video fr

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("fal-ai/wan-22", {
  input: {
    prompt: "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse."
  },
  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("fal-ai/wan-22", {
  input: {
    prompt: "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse."
  },
  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-22", {
  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-22", {
  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#

prompt string* required

The text prompt to guide video generation.

negative_prompt string

Negative prompt for video generation. Default value: "bright colors, overexposed, static, blurred details, subtitles, style, artwork, painting, picture, still, overall gray, worst quality, low quality, JPEG compression residue, ugly, incomplete, extra fingers, poorly drawn hands, poorly drawn faces, deformed, disfigured, malformed limbs, fused fingers, still picture, cluttered background, three legs, many people in the background, walking backwards"

num_frames integer

Number of frames to generate. Must be between 81 to 121 (inclusive). Default value: 81

frames_per_second integer

Frames per second of the generated video. Must be between 4 to 24. Default value: 16

seed integer

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

resolution ResolutionEnum

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

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

aspect_ratio AspectRatioEnum

Aspect ratio of the generated video (16:9 or 9:16). Default value: "16:9"

Possible enum values: 16:9, 9:16, 1:1

num_inference_steps integer

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

enable_safety_checker boolean

If set to true, input data will be checked for safety before processing.

enable_prompt_expansion boolean

Whether to enable prompt expansion. This will use a large language model to expand the prompt with additional details while maintaining the original meaning.

guidance_scale float

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

guidance_scale_2 float

Guidance scale for the second stage of the model. This is used to control the adherence to the prompt in the second stage of the model. Default value: 4

shift float

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

{
  "prompt": "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse.",
  "negative_prompt": "bright colors, overexposed, static, blurred details, subtitles, style, artwork, painting, picture, still, overall gray, worst quality, low quality, JPEG compression residue, ugly, incomplete, extra fingers, poorly drawn hands, poorly drawn faces, deformed, disfigured, malformed limbs, fused fingers, still picture, cluttered background, three legs, many people in the background, walking backwards",
  "num_frames": 81,
  "frames_per_second": 16,
  "resolution": "720p",
  "aspect_ratio": "16:9",
  "num_inference_steps": 30,
  "enable_safety_checker": true,
  "enable_prompt_expansion": false,
  "guidance_scale": 5,
  "guidance_scale_2": 4,
  "shift": 5
}

Output#

video File* required

The generated video file.

seed integer* required

The seed used for generation.

{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/web-examples/wan/t2v.mp4"
  }
}

Other types#

WanLoRAT2VRequest#

prompt string* required

The text prompt to guide video generation.

negative_prompt string

num_frames integer

Number of frames to generate. Must be between 81 to 121 (inclusive). Default value: 81

frames_per_second integer

Frames per second of the generated video. Must be between 4 to 24. Default value: 16

seed integer

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

resolution ResolutionEnum

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

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

aspect_ratio AspectRatioEnum

Aspect ratio of the generated video (16:9 or 9:16). Default value: "16:9"

Possible enum values: 16:9, 9:16, 1:1

num_inference_steps integer

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

enable_safety_checker boolean

If set to true, input data will be checked for safety before processing.

enable_prompt_expansion boolean

Whether to enable prompt expansion. This will use a large language model to expand the prompt with additional details while maintaining the original meaning.

guidance_scale float

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

guidance_scale_2 float

Guidance scale for the second stage of the model. This is used to control the adherence to the prompt in the second stage of the model. Default value: 4

shift float

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

loras list<LoRAWeight>

LoRA weights to be used in the inference.

reverse_video boolean

If true, the video will be reversed.

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.

file_data string

File data

LoRAWeight#

path string* required

URL or the path to the LoRA weights.

weight_name string

Name of the LoRA weight. Used only if path is a Hugging Face repository, and required only if you have more than 1 safetensors file in the repo.

scale float

The scale of the LoRA weight. This is used to scale the LoRA weight before merging it with the base model. Default value: 1

Loading related models...

Wan-2.2 Text-to-Video Text 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#

WanLoRAT2VRequest#

File#

LoRAWeight#