DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Phantom Image to Video

fal-ai/phantom/14b
Phantom is a unified video generation framework for single and multi-subject references, built on existing text-to-video and image-to-video architectures.
Inference
Commercial use
PlaygroundAPI

About

Generate 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

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/phantom/14b", {
  input: {
    prompt: "A cartoon old grandfather wearing a yellow hat, a yellow top and brown suspenders is holding a blue steaming coffee cup in a fresh cartoon-style cafe decorated with pink and blue tables and chairs, colorful chandeliers and colorful balls. The picture style is cartoony and fresh."
  },
  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/phantom/14b", {
  input: {
    prompt: "A cartoon old grandfather wearing a yellow hat, a yellow top and brown suspenders is holding a blue steaming coffee cup in a fresh cartoon-style cafe decorated with pink and blue tables and chairs, colorful chandeliers and colorful balls. The picture style is cartoony and fresh."
  },
  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/phantom/14b", {
  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/phantom/14b", {
  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

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"

input_image_urls list<string>

URL of images.

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: 30

cfg_scale float

CFG scale for the model. Default value: 1.5

guidance_scale float

Guidance scale for the model. Default value: 7.5

resolution ResolutionEnum

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

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

num_frames integer

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

shift float

Shift parameter for video generation. Default value: 5

frames_per_second integer

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

{
  "prompt": "A cartoon old grandfather wearing a yellow hat, a yellow top and brown suspenders is holding a blue steaming coffee cup in a fresh cartoon-style cafe decorated with pink and blue tables and chairs, colorful chandeliers and colorful balls. The picture style is cartoony and fresh.",
  "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",
  "input_image_urls": [
    "https://storage.googleapis.com/falserverless/phantom/ref14.png",
    "https://storage.googleapis.com/falserverless/phantom/ref15.png",
    "https://storage.googleapis.com/falserverless/phantom/ref16.png"
  ],
  "num_inference_steps": 30,
  "cfg_scale": 1.5,
  "guidance_scale": 7.5,
  "resolution": "720p",
  "num_frames": 81,
  "shift": 5,
  "frames_per_second": 16
}

Output#

Other types#