Animatediff SparseCtrl LCM

fal-ai/animatediff-sparsectrl-lcm
Inference
Commercial use

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/serverless-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 * as fal from "@fal-ai/serverless-client";

const result = await fal.subscribe("fal-ai/animatediff-sparsectrl-lcm", {
  input: {
    prompt: "Drone footage, futuristic city at night, synthwave, vaporware, neon lights, highly detailed, masterpeice, high quality"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});

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 * as fal from "@fal-ai/serverless-client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. 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 * as fal from "@fal-ai/serverless-client";

// Upload a file (you can get a file reference from an input element or a drag-and-drop event)
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

// Use the URL in your request
const result = await fal.subscribe("fal-ai/animatediff-sparsectrl-lcm", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

prompt*string

The prompt to use for generating the image. Be as descriptive as possible for best results.

negative_promptstring

The negative prompt to use. Use it to specify what you don't want. Default value: ""

controlnet_typeControlnetTypeEnum

The type of controlnet to use for generating the video. The controlnet determines how the video will be animated. Default value: "scribble"

Possible values: "scribble", "rgb"

num_inference_stepsinteger

Increasing the amount of steps tells Stable Diffusion that it should take more steps to generate your final result which can increase the amount of detail in your image. Default value: 4

guidance_scaleinteger

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. Default value: 1

seedinteger

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

keyframe_0_image_urlstring

The URL of the first keyframe to use for the generation.

keyframe_0_indexinteger

The frame index of the first keyframe to use for the generation.

keyframe_1_image_urlstring

The URL of the second keyframe to use for the generation.

keyframe_1_indexinteger

The frame index of the second keyframe to use for the generation.

keyframe_2_image_urlstring

The URL of the third keyframe to use for the generation.

keyframe_2_indexinteger

The frame index of the third keyframe to use for the generation.

{
  "prompt": "Drone footage, futuristic city at night, synthwave, vaporware, neon lights, highly detailed, masterpeice, high quality",
  "negative_prompt": "blurry, low resolution, bad, ugly, low quality, pixelated, interpolated, compression artifacts, noisey, grainy",
  "controlnet_type": "scribble",
  "num_inference_steps": 4,
  "guidance_scale": 1,
  "seed": 42,
  "keyframe_0_image_url": "https://storage.googleapis.com/falserverless/scribble2/scribble_2_1.png",
  "keyframe_0_index": 0,
  "keyframe_1_image_url": "https://storage.googleapis.com/falserverless/scribble2/scribble_2_2.png",
  "keyframe_1_index": 8,
  "keyframe_2_image_url": "https://storage.googleapis.com/falserverless/scribble2/scribble_2_3.png",
  "keyframe_2_index": 15
}

Output#

video*File

Generated video file.

seed*integer

The seed used to generate the video.

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