AnimateDiff Video-to-Video Evolved

fal-ai/animatediff-v2v
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-v2v", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/model_tests/animatediff_v2v/rocket.mp4",
    prompt: "masterpiece, best quality, rocket in space, galaxies in the background"
  },
  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-v2v", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

video_url*string

URL of the video.

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 address details that you don't want in the image. This could be colors, objects, scenery and even the small details (e.g. moustache, blurry, low resolution). Default value: "(bad quality, worst quality:1.2), ugly faces, bad anime"

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

guidance_scalefloat

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

base_modelBaseModelEnum

Base model to use for animation generation. Default value: "cardosAnimev20"

Possible values: "darkSushiMixMix_colorful", "cardosAnimev20"

loraslist<LoraWeight>

The list of LoRA weights to use. Default value: ``

select_every_nth_frameinteger

Select every Nth frame from the video. This can be used to reduce the number of frames to process, which can reduce the time and the cost. However, it can also reduce the quality of the final video. Default value: 2

seedinteger

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

{
  "video_url": "https://storage.googleapis.com/falserverless/model_tests/animatediff_v2v/rocket.mp4",
  "prompt": "masterpiece, best quality, rocket in space, galaxies in the background",
  "negative_prompt": "(bad quality, worst quality:1.2), ugly faces, bad anime",
  "num_inference_steps": 25,
  "guidance_scale": 7,
  "base_model": "cardosAnimev20",
  "loras": [],
  "select_every_nth_frame": 2,
  "seed": 537306
}

Output#

video*File

Generated video file.

seed*integer

Seed used for generating the video.

timings*Timings
{
  "video": {
    "content_type": "video/mp4",
    "url": "https://storage.googleapis.com/falserverless/model_tests/animatediff_v2v/turbo-rocket-output.mp4"
  }
}