Upscale videos with Bytedance's video upscaler.
fal-ai/bytedance-upscaler/upscale/video
Upscale videos with Bytedance's video upscaler.
Inference
Commercial use
Partner
Loading API documentation
Enhance and upscale a video using BytePlus VOD.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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/bytedance-upscaler/upscale/video", {
input: {
video_url: "https://storage.googleapis.com/falserverless/example_inputs/bytedance_video_upscaler_input.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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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/bytedance-upscaler/upscale/video", {
input: {
video_url: "https://storage.googleapis.com/falserverless/example_inputs/bytedance_video_upscaler_input.mp4"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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/bytedance-upscaler/upscale/video", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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/bytedance-upscaler/upscale/video", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
video_url string* requiredThe URL of the video to upscale.
target_resolution TargetResolutionEnumThe target resolution of the video to upscale. Default value: "1080p"
Possible enum values: 1080p, 2k, 4k, 6k, 8k
target_fps floatThe target frame rate of the enhanced video in frames per second. Default value: 30
enhancement_preset EnhancementPresetEnumThe enhancement preset optimized for specific video scenarios. 'general' is a general-purpose template, 'ugc' targets user-generated short videos, 'short_series' is for short dramas, 'aigc' is for AI-generated content, and 'old_film' is for classic film restoration. Default value: "general"
Possible enum values: general, ugc, short_series, aigc, old_film
enhancement_tier EnhancementTierEnumThe enhancement quality tier. 'fast' provides essential upscaling with good speed, 'standard' uses adaptive algorithms for better visual texture, 'pro' uses large-model restoration for cinematic quality (longer processing time), and 10 times the cost of standard and fast. Default value: "standard"
Possible enum values: fast, standard, pro
scale_ratio floatThe scaling ratio for the output video resolution. When set, overrides target_resolution and scales the input resolution by this factor (e.g., 2.0 doubles the resolution). Range: 1.1 to 10.0. Please note that this is valid only up to 4k resolution, and trying to scale beyond 4k will result in an error. (4k is defined as having atotal pixel count of 3840x2160).
fidelity FidelityEnumThe enhancement intensity. 'high' applies mild enhancement while keeping visual texture close to the source video. 'medium' provides a balanced image quality enhancement. Default value: "high"
Possible enum values: high, medium
bit_depth BitDepthEnumThe color bit depth of the output video. 10-bit and 12-bit output require the Pro enhancement tier. Default value: "8"
Possible enum values: 8, 10, 12
{
"video_url": "https://storage.googleapis.com/falserverless/example_inputs/bytedance_video_upscaler_input.mp4",
"target_resolution": "1080p",
"target_fps": 30,
"enhancement_preset": "general",
"enhancement_tier": "standard",
"fidelity": "high",
"bit_depth": 8
}Generated video file
duration float* requiredDuration of audio input/video output as used for billing.
{
"video": {
"url": "https://storage.googleapis.com/falserverless/example_outputs/bytedance_video_upscaler_output.mp4"
}
}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.