fal Sandbox is here - run all your models together! 🏖️
DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

SeedVR2 Video to Video

fal-ai/seedvr/upscale/video
Upscale your videos using SeedVR2 with temporal consistency!
Inference
Commercial use
PlaygroundAPI

About

Upscale 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

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/seedvr/upscale/video", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/example_inputs/seedvr-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/seedvr/upscale/video", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/example_inputs/seedvr-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/seedvr/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/seedvr/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 input video to be processed

upscale_mode UpscaleModeEnum

The mode to use for the upscale. If 'target', the upscale factor will be calculated based on the target resolution. If 'factor', the upscale factor will be used directly. Default value: "factor"

Possible enum values: target, factor

upscale_factor float

Upscaling factor to be used. Will multiply the dimensions with this factor when upscale_mode is factor. Default value: 2

target_resolution TargetResolutionEnum

The target resolution to upscale to when upscale_mode is target. Default value: "1080p"

Possible enum values: 720p, 1080p, 1440p, 2160p

seed integer

The random seed used for the generation process.

noise_scale float

The noise scale to use for the generation process. Default value: 0.1

output_format OutputFormatEnum

The format of the output video. Default value: "X264 (.mp4)"

Possible enum values: X264 (.mp4), VP9 (.webm), PRORES4444 (.mov), GIF (.gif)

output_quality OutputQualityEnum

The quality of the output video. Default value: "high"

Possible enum values: low, medium, high, maximum

output_write_mode OutputWriteModeEnum

The write mode of the output video. Default value: "balanced"

Possible enum values: fast, balanced, small

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

{
  "video_url": "https://storage.googleapis.com/falserverless/example_inputs/seedvr-input.mp4",
  "upscale_mode": "factor",
  "upscale_factor": 2,
  "target_resolution": "1080p",
  "noise_scale": 0.1,
  "output_format": "X264 (.mp4)",
  "output_quality": "high",
  "output_write_mode": "balanced"
}

Output#

video File* required

Upscaled video file after processing

seed integer* required

The random seed used for the generation process.

{
  "video": {
    "content_type": "video/mp4",
    "url": "https://storage.googleapis.com/falserverless/example_outputs/seedvr-output.mp4"
  }
}

Other types#

ImageFile#

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.

file_data string

File data

width integer

The width of the image

height integer

The height of the image

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.

file_data string

File data

Related Models