Hunyuan Video Text to Video
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
Migrate 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/hunyuan-video", {
input: {
prompt: "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse."
},
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/hunyuan-video", {
input: {
prompt: "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse."
},
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/hunyuan-video", {
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/hunyuan-video", {
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#
prompt
string
* requiredThe prompt to generate the video from.
num_inference_steps
integer
The number of inference steps to run. Lower gets faster results, higher gets better results. Default value: 30
seed
integer
The seed to use for generating the video.
pro_mode
boolean
By default, generations are done with 35 steps. Pro mode does 55 steps which results in higher quality videos but will take more time and cost 2x more billing units.
aspect_ratio
AspectRatio(W:H)Enum
The aspect ratio of the video to generate. Default value: "16:9"
Possible enum values: 16:9, 9:16
resolution
ResolutionEnum
The resolution of the video to generate. Default value: "720p"
Possible enum values: 480p, 580p, 720p
num_frames
NumberofFramesEnum
The number of frames to generate. Default value: "129"
Possible enum values: 129, 85
enable_safety_checker
boolean
If set to true, the safety checker will be enabled.
{
"prompt": "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse.",
"num_inference_steps": 30,
"aspect_ratio": "16:9",
"resolution": "720p",
"num_frames": 129,
"enable_safety_checker": true
}
Output#
seed
integer
* requiredThe seed used for generating the video.
{
"video": {
"url": "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
}
}
Other types#
LoraWeight#
path
string
* requiredURL or the path to the LoRA weights.
scale
float
The scale of the LoRA weight. This is used to scale the LoRA weight
before merging it with the base model. Default value: 1
File#
url
string
* requiredThe 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
HunyuanV2VRequest#
prompt
string
* requiredThe prompt to generate the video from.
num_inference_steps
integer
The number of inference steps to run. Lower gets faster results, higher gets better results. Default value: 30
seed
integer
The seed to use for generating the video.
pro_mode
boolean
By default, generations are done with 35 steps. Pro mode does 55 steps which results in higher quality videos but will take more time and cost 2x more billing units.
aspect_ratio
AspectRatio(W:H)Enum
The aspect ratio of the video to generate. Default value: "16:9"
Possible enum values: 16:9, 9:16
resolution
ResolutionEnum
The resolution of the video to generate. Default value: "720p"
Possible enum values: 480p, 580p, 720p
num_frames
NumberofFramesEnum
The number of frames to generate. Default value: "129"
Possible enum values: 129, 85
enable_safety_checker
boolean
If set to true, the safety checker will be enabled.
video_url
string
* requiredURL of the video input.
strength
float
Strength for Video-to-Video Default value: 0.85