DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Svd Unknown

fal-ai/svd
Inference
Private
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/svd", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/svd/rocket.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/svd", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/svd/rocket.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/svd", {
  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/svd", {
  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#

image_url string* required

The URL of the image to use as a starting point for the generation.

mask_image_url string

The URL of the image to use as a mask for the generation. The mask should be a black and white image, where black represents the area that will be will move, and white represents the area that will stay still.

control_maps_data_url string

A sequence of depths maps as a archive file url. A depth map is need for every frame. The frame count for the video will equal the number of depth map frames in the archive. The images will be sorted by file name. Acceptable image extensions are: '.jpg', '.jpeg', '.png', '.bmp', '.gif', or '.tiff'. All other files will be ignored.

motion_bucket_id integer

The motion bucket id determines the motion of the generated video. The higher the number, the more motion there will be. Default value: 127

cond_aug float

The conditoning augmentation determines the amount of noise that will be added to the conditioning frame. The higher the number, the more noise there will be, and the less the video will look like the initial image. Increase it for more motion. Default value: 0.02

seed integer

The same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.

steps integer

The number of steps to run the model for. The higher the number the better the quality and longer it will take to generate. Default value: 20

{
  "image_url": "https://storage.googleapis.com/falserverless/model_tests/svd/rocket.png",
  "motion_bucket_id": 127,
  "cond_aug": 0.02,
  "steps": 20
}

Output#

image File* required

The generated video file.

seed integer* required

Seed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.

{
  "image": {
    "url": "https://url.to/generated/file/z9RV14K95DvU.png",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019
  }
}

Other types#

File#

url string* required

The URL where the file can be downloaded from.

content_type string* required

The mime type of the file.

file_name string* required

The name of the file. It will be auto-generated if not provided.

file_size integer* required

The size of the file in bytes.