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

fal-ai/bytedance-upscaler/upscale/video

Upscale videos with Bytedance's video upscaler.
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

Table of contents

About

Upscale a video to 4x resolution using Bytedance's video upscaler model.

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/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);

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/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",
});

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/bytedance-upscaler/upscale/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/bytedance-upscaler/upscale/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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

video_url string* required

The URL of the video to upscale.

target_resolution TargetResolutionEnum

The target resolution of the video to upscale. Default value: "1080p"

Possible enum values: 1080p, 2k, 4k

target_fps TargetFpsEnum

The target FPS of the video to upscale. Default value: "30fps"

Possible enum values: 30fps, 60fps

enhancement_preset EnhancementPresetEnum

The 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 EnhancementTierEnum

The 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 float

The 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 FidelityEnum

The 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

{
  "video_url": "https://storage.googleapis.com/falserverless/example_inputs/bytedance_video_upscaler_input.mp4",
  "target_resolution": "1080p",
  "target_fps": "30fps",
  "enhancement_preset": "general",
  "enhancement_tier": "standard",
  "fidelity": "high"
}

Output#

video File* required

Generated video file

duration float* required

Duration of audio input/video output as used for billing.

{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/example_outputs/bytedance_video_upscaler_output.mp4"
  }
}

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.