Run models all in one Sandbox 🏖️
Docs
Log-inSign-up

fal-ai/toon-crafter

Create animated videos from keyframe images.
Inference
Commercial use
Schema
LLMs
PlaygroundAPI

Table of contents

About

Generate

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/toon-crafter", {
  input: {
    keyframe_image_urls: ["https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j6zuawAAAmZq.png", "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j8Oya0AAzOhA.png", "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j9cbaAAErqZa.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/toon-crafter", {
  input: {
    keyframe_image_urls: ["https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j6zuawAAAmZq.png", "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j8Oya0AAzOhA.png", "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j9cbaAAErqZa.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/toon-crafter", {
  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/toon-crafter", {
  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#

keyframe_image_urls list<string>* required

List of keyframe images, ideally 2-4 images.

steps integer

The number of steps to generate the video. Default value: 50

prompt string

The text prompt to generate the video. Default value: ""

keyframe_lengths list<integer>

The number of frames for each keyframe image. If none the keyframes are given equal number of frames. If specified the total frames most equal the model temporal length.

cfg_scale float

The scale of the configuration. Default value: 7.5

eta float

The eta value for DDIM sampling. Default value: 1

motion_steps integer

The motion scale. Default value: 10

fps integer

The frames per second of the output video. Default value: 8

seed integer

The seed for the random number generator.

{
  "keyframe_image_urls": [
    "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j6zuawAAAmZq.png",
    "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j8Oya0AAzOhA.png",
    "https://storage.googleapis.com/falserverless/model_tests/toon-crafter/GO7j9cbaAAErqZa.png"
  ],
  "steps": 50,
  "prompt": "A army general swings his arm",
  "cfg_scale": 7.5,
  "eta": 1,
  "motion_steps": 10,
  "fps": 8
}

Output#

video File* required

The generated video file.

seed integer* required

The seed used for the random number generator.

{
  "video": {
    "url": "",
    "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

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.