Steady Dancer Video to Video
About
Generate a dance animation video from a reference image and driving pose 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/clientMigrate to @fal-ai/client
The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.
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/steady-dancer", {
input: {},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});Protect your API Key
When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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/steady-dancer", {
input: {},
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/steady-dancer", {
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/steady-dancer", {
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);Auto uploads
The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).
Read more about file handling in our file upload guide.
5. Schema#
Input#
image_url stringURL of the reference image to animate. This is the person/character whose appearance will be preserved. Default value: "https://v3b.fal.media/files/b/0a85edaa/GDUCMPrdvOMcI5JpEcU7f.png"
video_url stringURL of the driving pose video. The motion from this video will be transferred to the reference image. Default value: "https://v3b.fal.media/files/b/0a84de68/jXDWywjhagRfR-GuZjoRs_video.mp4"
prompt stringText prompt describing the desired animation. Default value: "A person dancing with smooth and natural movements."
negative_prompt stringNegative prompt for video generation. Default value: "blurred, distorted face, bad anatomy, extra limbs, poorly drawn hands, poorly drawn feet, disfigured, out of frame, duplicate, watermark, signature, text"
frames_per_second integerFrames per second of the generated video. Must be between 5 to 24. Default value: 16
seed integerRandom seed for reproducibility. If None, a random seed is chosen.
resolution ResolutionEnumResolution of the generated video. 576p is default, 720p for higher quality. 480p is lower quality. Default value: "576p"
Possible enum values: 480p, 576p, 720p
num_inference_steps integerNumber of inference steps for sampling. Higher values give better quality but take longer. Default value: 30
guidance_scale floatClassifier-free guidance scale for prompt adherence. Default value: 5
pose_guidance_scale floatPose guidance scale for pose control strength. Default value: 1
shift floatShift parameter for video generation. Default value: 5
pose_guidance_start floatStart ratio for pose guidance. Controls when pose guidance begins. Default value: 0.1
pose_guidance_end floatEnd ratio for pose guidance. Controls when pose guidance ends. Default value: 0.4
acceleration AccelerationEnumAcceleration levels. Default value: "aggressive"
Possible enum values: light, moderate, aggressive
enable_safety_checker booleanIf set to true, the safety checker will be enabled.
aspect_ratio AspectRatioEnumAspect ratio of the generated video. If 'auto', will be determined from the reference image. Default value: "auto"
Possible enum values: auto, 16:9, 9:16, 1:1
num_frames integerNumber of frames to generate. Will be adjusted to nearest valid value (must satisfy 4k+1 pattern). Default value: 81
preserve_audio booleanIf enabled, copies audio from the input driving video to the output video. Default value: true
{
"image_url": "https://v3b.fal.media/files/b/0a85edaa/GDUCMPrdvOMcI5JpEcU7f.png",
"video_url": "https://v3b.fal.media/files/b/0a84de68/jXDWywjhagRfR-GuZjoRs_video.mp4",
"prompt": "A person dancing with smooth and natural movements.",
"negative_prompt": "blurred, distorted face, bad anatomy, extra limbs, poorly drawn hands, poorly drawn feet, disfigured, out of frame, duplicate, watermark, signature, text",
"frames_per_second": 16,
"resolution": "576p",
"num_inference_steps": 30,
"guidance_scale": 5,
"pose_guidance_scale": 1,
"shift": 5,
"pose_guidance_start": 0.1,
"pose_guidance_end": 0.4,
"acceleration": "aggressive",
"enable_safety_checker": true,
"aspect_ratio": "auto",
"num_frames": 81,
"preserve_audio": true
}Output#
The generated dance animation video.
seed integer* requiredThe seed used for generation.
num_frames integer* requiredThe actual number of frames generated (aligned to 4k+1 pattern).
{
"video": {
"file_size": 7772111,
"file_name": "wGTyD08J5aZYkH5lHUj72_output_with_audio.mp4",
"content_type": "application/octet-stream",
"url": "https://v3b.fal.media/files/b/0a85ef77/wGTyD08J5aZYkH5lHUj72_output_with_audio.mp4"
}
}Other types#
File#
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
file_data stringFile data