DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

MusePose Video to Video

fal-ai/muse-pose
Animate a reference image with a driving video using MusePose.
Inference
Commercial use
PlaygroundAPI

About

Run

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/muse-pose", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/musepose/ref.png",
    video_url: "https://storage.googleapis.com/falserverless/model_tests/musepose/dance.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/muse-pose", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/musepose/ref.png",
    video_url: "https://storage.googleapis.com/falserverless/model_tests/musepose/dance.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/muse-pose", {
  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/muse-pose", {
  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

URL of the image to animate.

video_url string* required

The URL of the video to drive the animation

dwpose_detection_resolution integer

The resolution to use for the pose detection. Default value: 512

dwpose_image_resolution integer

The resolution to use for the image during pose calculation. Default value: 720

dwpose_align_frame integer

The frame to align the pose to.

width integer

The width of the output video. Default value: 748

height integer

The height of the output video. Default value: 748

length integer

The length of the output video. Default value: 300

slice integer

The video slice frame number Default value: 48

overlap integer

The video slice overlap frame number Default value: 4

cfg float

Classifier free guidance Default value: 3.5

seed integer

The seed to use for the random number generator.

steps integer

DDIM sampling steps Default value: 20

fps integer

The frames per second of the output video.

skip integer

Number of input frames to skip. Skipping 1 effectively reduces the fps in half. Default value: 1

{
  "image_url": "https://storage.googleapis.com/falserverless/model_tests/musepose/ref.png",
  "video_url": "https://storage.googleapis.com/falserverless/model_tests/musepose/dance.mp4",
  "dwpose_detection_resolution": 512,
  "dwpose_image_resolution": 720,
  "width": 748,
  "height": 748,
  "length": 300,
  "slice": 48,
  "overlap": 4,
  "cfg": 3.5,
  "steps": 20,
  "skip": 1
}

Output#

video File* required

The generated video with the lip sync.

{
  "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.

file_data string

File data