DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Topaz Video Upscale Video to Video

fal-ai/topaz/upscale/video
Professional-grade video upscaling using Topaz technology. Enhance your videos with high-quality upscaling.
Inference
Commercial use
Partner
PlaygroundAPI

About

Upscale videos using Topaz Video AI.

Uses Proteus v4 for upscaling and optionally Apollo v8 for frame interpolation. Supports up to 8x upscaling and 120 FPS output. Frame interpolation is automatically enabled when target_fps is set.

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/topaz/upscale/video", {
  input: {
    video_url: "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.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/topaz/upscale/video", {
  input: {
    video_url: "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.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/topaz/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/topaz/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

URL of the video to upscale

upscale_factor float

Factor to upscale the video by (e.g. 2.0 doubles width and height) Default value: 2

target_fps integer

Target FPS for frame interpolation. If set, frame interpolation will be enabled.

{
  "video_url": "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4",
  "upscale_factor": 2
}

Output#

video File* required

The upscaled video file

{
  "video": {
    "url": "https://v3.fal.media/files/penguin/ztj_LB4gQlW6HIfVs8zX4_upscaled.mp4"
  }
}

Other types#

SlowMotionRequest#

video_url string* required

URL of the video to apply slow motion to

slowdown_factor integer

Factor to slow down the video by (e.g. 4 means 4x slower) Default value: 4

upscale_factor float

Optional factor to upscale the video by (e.g. 2.0 doubles width and height)

StrongAIUpscaleRequest#

video_url string* required

URL of the AI-generated video to upscale

target_width integer

Target width of the output video Default value: 5120

target_height integer

Target height of the output video Default value: 2880

target_fps integer

Target FPS for the output video. Defaults to source FPS if not specified.

RecoverUpscaleRequest#

video_url string* required

URL of the low-quality video to upscale and recover

upscale_factor float

Factor to upscale the video by (e.g. 2.0 doubles width and height) Default value: 2

target_fps integer

Target FPS for the output video. Defaults to source FPS if not specified.

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.