DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Framepack Image to Video

fal-ai/framepack
Framepack is an efficient Image-to-video model that autoregressively generates videos.
Inference
Commercial use
PlaygroundAPI

About

Generate Video Regular Endpoint

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/framepack", {
  input: {
    prompt: "A mesmerising video of a deep sea jellyfish moving through an inky-black ocean. The jellyfish glows softly with an amber bioluminescence. The overall scene is lifelike.",
    image_url: "https://storage.googleapis.com/falserverless/framepack/framepack.jpg"
  },
  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/framepack", {
  input: {
    prompt: "A mesmerising video of a deep sea jellyfish moving through an inky-black ocean. The jellyfish glows softly with an amber bioluminescence. The overall scene is lifelike.",
    image_url: "https://storage.googleapis.com/falserverless/framepack/framepack.jpg"
  },
  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/framepack", {
  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/framepack", {
  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 500 characters).

negative_prompt string

Negative prompt for video generation. Default value: ""

image_url string* required

URL of the image input.

seed integer

The seed to use for generating the video.

aspect_ratio AspectRatio(W:H)Enum

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

Possible enum values: 16:9, 9:16

resolution ResolutionEnum

The resolution of the video to generate. 720p generations cost 1.5x more than 480p generations. Default value: "480p"

Possible enum values: 720p, 480p

cfg_scale float

Classifier-Free Guidance scale for the generation. Default value: 1

guidance_scale float

Guidance scale for the generation. Default value: 10

num_frames integer

The number of frames to generate. Default value: 180

enable_safety_checker boolean

If set to true, the safety checker will be enabled.

{
  "prompt": "A mesmerising video of a deep sea jellyfish moving through an inky-black ocean. The jellyfish glows softly with an amber bioluminescence. The overall scene is lifelike.",
  "negative_prompt": "Ugly, blurry distorted, bad quality",
  "image_url": "https://storage.googleapis.com/falserverless/framepack/framepack.jpg",
  "aspect_ratio": "16:9",
  "resolution": "480p",
  "cfg_scale": 1,
  "guidance_scale": 10,
  "num_frames": 180,
  "enable_safety_checker": true
}

Output#

video File* required
seed integer* required

The seed used for generating the video.

{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/framepack/TfJPbwm6_D60dcWEv9LVX_output_video.mp4"
  }
}

Other types#

FramePackF1Response#

video File* required
seed integer* required

The seed used for generating the video.

FramePackF1Request#

prompt string* required

Text prompt for video generation (max 500 characters).

negative_prompt string

Negative prompt for video generation. Default value: ""

image_url string* required

URL of the image input.

seed integer

The seed to use for generating the video.

aspect_ratio AspectRatio(W:H)Enum

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

Possible enum values: 16:9, 9:16

resolution ResolutionEnum

The resolution of the video to generate. 720p generations cost 1.5x more than 480p generations. Default value: "480p"

Possible enum values: 720p, 480p

cfg_scale float

Classifier-Free Guidance scale for the generation. Default value: 1

guidance_scale float

Guidance scale for the generation. Default value: 10

num_frames integer

The number of frames to generate. Default value: 180

enable_safety_checker boolean

If set to true, the safety checker will be enabled.

FramePackF2LFRequest#

prompt string* required

Text prompt for video generation (max 500 characters).

negative_prompt string

Negative prompt for video generation. Default value: ""

image_url string* required

URL of the image input.

seed integer

The seed to use for generating the video.

aspect_ratio AspectRatio(W:H)Enum

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

Possible enum values: 16:9, 9:16

resolution ResolutionEnum

The resolution of the video to generate. 720p generations cost 1.5x more than 480p generations. Default value: "480p"

Possible enum values: 720p, 480p

cfg_scale float

Classifier-Free Guidance scale for the generation. Default value: 1

guidance_scale float

Guidance scale for the generation. Default value: 10

num_frames integer

The number of frames to generate. Default value: 240

enable_safety_checker boolean

If set to true, the safety checker will be enabled.

end_image_url string* required

URL of the end image input.

strength float

Determines the influence of the final frame on the generated video. Higher values result in the output being more heavily influenced by the last frame. Default value: 0.8

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.

FramePackFLF2VResponse#

video File* required
seed integer* required

The seed used for generating the video.

Related Models