Vidu Reference to Video Image to Video

fal-ai/vidu/reference-to-video
Vidu Reference to Video creates videos by using a reference images and combining them with a prompt.
Inference
Commercial use
Partner

About

Vidu Reference to Video API: Generate a video with consistent subjects using reference images.

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

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/vidu/reference-to-video", {
  input: {
    prompt: "The little devil is looking at the apple on the beach and walking around it.",
    reference_image_urls: ["https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference1.png", "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference2.png", "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference3.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 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"
});

3. Queue#

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/vidu/reference-to-video", {
  input: {
    prompt: "The little devil is looking at the apple on the beach and walking around it.",
    reference_image_urls: ["https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference1.png", "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference2.png", "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference3.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/vidu/reference-to-video", {
  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/vidu/reference-to-video", {
  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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

Text prompt for video generation, max 1500 characters

reference_image_urls list<string>* required

URLs of the reference images to use for consistent subject appearance

seed integer

Random seed for generation

aspect_ratio AspectRatioEnum

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

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

movement_amplitude MovementAmplitudeEnum

The movement amplitude of objects in the frame Default value: "auto"

Possible enum values: auto, small, medium, large

{
  "prompt": "The little devil is looking at the apple on the beach and walking around it.",
  "reference_image_urls": [
    "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference1.png",
    "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference2.png",
    "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference3.png"
  ],
  "aspect_ratio": "16:9",
  "movement_amplitude": "auto"
}

Output#

video File* required

The generated video with consistent subjects from reference images

{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/referencevideo.mp4"
  }
}

Other types#

Q1StartEndToVideoRequest#

prompt string* required

Text prompt for video generation, max 1500 characters

start_image_url string* required

URL of the image to use as the first frame

end_image_url string* required

URL of the image to use as the last frame

seed integer

Seed for the random number generator

movement_amplitude MovementAmplitudeEnum

The movement amplitude of objects in the frame Default value: "auto"

Possible enum values: auto, small, medium, large

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.

ImageToVideoRequest#

prompt string* required

Text prompt for video generation, max 1500 characters

image_url string* required

URL of the image to use as the first frame

seed integer

Random seed for generation

movement_amplitude MovementAmplitudeEnum

The movement amplitude of objects in the frame Default value: "auto"

Possible enum values: auto, small, medium, large

TemplateToVideoRequest#

template TemplateEnum

AI video template to use. Pricing varies by template: Standard templates (hug, kiss, love_pose, etc.) cost 4 credits ($0.20), Premium templates (lunar_newyear, dynasty_dress, dreamy_wedding, etc.) cost 6 credits ($0.30), and Advanced templates (live_photo) cost 10 credits ($0.50). Default value: "hug"

Possible enum values: dreamy_wedding, romantic_lift, sweet_proposal, couple_arrival, cupid_arrow, pet_lovers, lunar_newyear, hug, kiss, dynasty_dress, wish_sender, love_pose, hair_swap, youth_rewind, morphlab, live_photo, emotionlab, live_memory, interaction, christmas

input_image_urls list<string>* required

URLs of the images to use with the template. Number of images required varies by template: 'dynasty_dress' and 'shop_frame' accept 1-2 images, 'wish_sender' requires exactly 3 images, all other templates accept only 1 image.

prompt string* required

Text prompt for video generation, max 1500 characters

seed integer

Random seed for generation

aspect_ratio AspectRatioEnum

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

Possible enum values: 16:9, 9:16

Q1ImageToVideoRequest#

prompt string* required

Text prompt for video generation, max 1500 characters

image_url string* required

URL of the image to use as the first frame

seed integer

Seed for the random number generator

movement_amplitude MovementAmplitudeEnum

The movement amplitude of objects in the frame Default value: "auto"

Possible enum values: auto, small, medium, large

Q1TextToVideoRequest#

prompt string* required

Text prompt for video generation, max 1500 characters

style StyleEnum

The style of output video Default value: "general"

Possible enum values: general, anime

seed integer

Seed for the random number generator

aspect_ratio AspectRatioEnum

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

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

movement_amplitude MovementAmplitudeEnum

The movement amplitude of objects in the frame Default value: "auto"

Possible enum values: auto, small, medium, large

StartEndToVideoRequest#

prompt string* required

Text prompt for video generation, max 1500 characters

start_image_url string* required

URL of the image to use as the first frame

end_image_url string* required

URL of the image to use as the last frame

seed integer

Random seed for generation

movement_amplitude MovementAmplitudeEnum

The movement amplitude of objects in the frame Default value: "auto"

Possible enum values: auto, small, medium, large

Related Models