Wan Alpha | Text to Video

fal-ai/wan-alpha

Generate videos with transparent backgrounds

Inference

Commercial use

Schema

LLMs

Playground API

About

Generate a video from a text prompt.

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-alpha", {
  input: {
    prompt: "Medium shot. A little girl holds a bubble wand and blows out colorful bubbles that float and pop in the air. The background of this video is transparent. Realistic style."
  },
  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-alpha", {
  input: {
    prompt: "Medium shot. A little girl holds a bubble wand and blows out colorful bubbles that float and pop in the air. The background of this video is transparent. Realistic style."
  },
  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-alpha", {
  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-alpha", {
  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 prompt to guide the video generation.

num_frames integer

The number of frames to generate. Default value: 81

fps integer

The frame rate of the generated video. Default value: 16

num_inference_steps integer

The number of inference steps to use. Default value: 8

seed integer

The seed for the random number generator.

sampler SamplerEnum

The sampler to use. Default value: "euler"

Possible enum values: unipc, dpm++, euler

shift float

The shift of the generated video. Default value: 10.5

resolution ResolutionEnum

The resolution of the generated video. Default value: "480p"

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

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video. Default value: "16:9"

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

enable_prompt_expansion boolean

Whether to enable prompt expansion.

enable_safety_checker boolean

Whether to enable safety checker. Default value: true

mask_clamp_lower float

The lower bound of the mask clamping. Default value: 0.1

mask_clamp_upper float

The upper bound of the mask clamping. Default value: 0.75

binarize_mask boolean

Whether to binarize the mask.

mask_binarization_threshold float

The threshold for mask binarization. When binarize_mask is True, this threshold will be used to binarize the mask. This will also be used for transparency when the output type is .webm. Default value: 0.8

video_output_type VideoOutputTypeEnum

The output type of the generated video. Default value: "VP9 (.webm)"

Possible enum values: X264 (.mp4), VP9 (.webm), PRORES4444 (.mov), GIF (.gif)

video_quality VideoQualityEnum

The quality of the generated video. Default value: "high"

Possible enum values: low, medium, high, maximum

video_write_mode VideoWriteModeEnum

The write mode of the generated video. Default value: "balanced"

Possible enum values: fast, balanced, small

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

{
  "prompt": "Medium shot. A little girl holds a bubble wand and blows out colorful bubbles that float and pop in the air. The background of this video is transparent. Realistic style.",
  "num_frames": 81,
  "fps": 16,
  "num_inference_steps": 8,
  "sampler": "euler",
  "shift": 10.5,
  "resolution": "480p",
  "aspect_ratio": "16:9",
  "enable_safety_checker": true,
  "mask_clamp_lower": 0.1,
  "mask_clamp_upper": 0.75,
  "mask_binarization_threshold": 0.8,
  "video_output_type": "VP9 (.webm)",
  "video_quality": "high",
  "video_write_mode": "balanced"
}

Output#

prompt string* required

The prompt used for generation.

seed integer* required

The seed used for generation.

video VideoFile

The generated video file.

image VideoFile

The generated image file.

mask VideoFile

The generated mask file.

{
  "prompt": "Medium shot. A little girl holds a bubble wand and blows out colorful bubbles that float and pop in the air. The background of this video is transparent. Realistic style.",
  "seed": 424911732,
  "video": {
    "height": 720,
    "file_name": "wan-alpha-rgba-output.webm",
    "content_type": "video/webm",
    "url": "https://storage.googleapis.com/falserverless/example_outputs/wan-alpha-rgba-output.webm",
    "width": 1280
  },
  "mask": {
    "height": 720,
    "duration": 5.0625,
    "url": "https://storage.googleapis.com/falserverless/example_outputs/wan-alpha-mask-output.webm",
    "fps": 16,
    "width": 1280,
    "file_name": "wan-alpha-mask-output.webm",
    "content_type": "video/webm",
    "num_frames": 81
  }
}

Other types#

VideoFile#

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 video

height integer

The height of the video

fps float

The FPS of the video

duration float

The duration of the video

num_frames integer

The number of frames in the video

Wan Alpha 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#

VideoFile#