DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Magic Animate Unknown

fal-ai/magic-animate
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/magic-animate", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/gallery/monalisa.png",
    motion_sequence_url: "https://storage.googleapis.com/falserverless/gallery/running2.mp4"
  },
  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/magic-animate", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/gallery/monalisa.png",
    motion_sequence_url: "https://storage.googleapis.com/falserverless/gallery/running2.mp4"
  },
  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/magic-animate", {
  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/magic-animate", {
  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.

seed integer

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

guidance_scale float

The strength of the guidance. Higher values will make the model more likely to generate images that are similar to the prompt. Default is 7.5. Default value: 7.5

motion_sequence_url string* required

The video file for DensePose annotations. This will drive the motion of the video

size integer

The size of the output video. The model will resize the image to this size before generating the video. Default value: 512

steps integer

The number of steps to run the model for. Default is 25. Default value: 25

context_frames integer

The number of frames to use for each sliding window context. Default is 16. Default value: 16

context_overlap integer

The number of frames to overlap between two sliding windows. Default is 3. Default value: 4

{
  "image_url": "https://storage.googleapis.com/falserverless/gallery/monalisa.png",
  "guidance_scale": 7.5,
  "motion_sequence_url": "https://storage.googleapis.com/falserverless/gallery/running2.mp4",
  "size": 512,
  "steps": 25,
  "context_frames": 16,
  "context_overlap": 4
}

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.