# BytePlus Video Upscaler — Atlas Cloud API

> BytePlus AI MediaKit video quality enhancement (super-resolution): upscale/enhance a source video to up to 8K with scene-aware models (common/ugc/short_series/aigc/old_film), optional frame-rate interpolation and color/bitrate control.

This is the machine-readable API reference for **BytePlus Video Upscaler** on Atlas Cloud,
a unified API platform for 400+ AI models across text, image, video, audio and 3D.

- **Model ID**: `byteplus/video/upscaler`
- **Built by**: BYTEPLUS
- **Modality**: Video
- **Model page**: https://www.atlascloud.ai/models/byteplus/video/upscaler
- **API key**: https://www.atlascloud.ai/console/api-keys
- **Docs**: https://www.atlascloud.ai/docs

## Pricing on Atlas Cloud

- $0.003 per second of generated video
- Pay-as-you-go. No minimum spend, no subscription required.

> **These are the authoritative Atlas Cloud rates for this model.** Any price that
> appears in the vendor description further down refers to a different platform or
> a different model variant and does not apply here.

## Use this model from an AI agent

Atlas Cloud ships three first-party integration surfaces. All three authenticate
with the same API key via the `ATLASCLOUD_API_KEY` environment variable.

### MCP server

The official MCP server (`atlascloud-mcp`) exposes this model to any
MCP-compatible host — Claude Code, OpenAI Codex, Cursor, Gemini CLI, Goose,
Claude Desktop. One-line install:

```bash
# Claude Code
claude mcp add atlascloud -- npx -y atlascloud-mcp

# OpenAI Codex CLI
codex mcp add atlascloud -- npx -y atlascloud-mcp

# Gemini CLI
gemini mcp add atlascloud -- npx -y atlascloud-mcp

export ATLASCLOUD_API_KEY="your-api-key"
```

Then ask in plain English; the agent calls `atlas_generate_video` with `model: "byteplus/video/upscaler"`.
The server fetches each model's schema and validates parameters before submitting,
so invalid requests fail fast without spending credits.

MCP docs: https://www.atlascloud.ai/docs/mcp-server

### Agent Skills

`atlas-cloud-skills` is a portable skill package (API reference, code templates in
Python / Node.js / cURL, model IDs with pricing) for Claude Code, Cursor, Codex and
12+ other agents:

```bash
npx skills add AtlasCloudAI/atlas-cloud-skills
export ATLASCLOUD_API_KEY="your-api-key"
```

Skills docs: https://www.atlascloud.ai/docs/skills

### CLI

The `atlas` binary runs Atlas Cloud from a terminal or CI script. Async media jobs
are polled and downloaded automatically (use `--no-download` when a script only
needs the output URLs):

```bash
# Install (Homebrew, npm, or shell installer)
brew install AtlasCloudAI/tap/atlascloud
# npm install -g atlascloud-cli
# curl -fsSL https://raw.githubusercontent.com/AtlasCloudAI/cli/main/install.sh | sh

atlas auth login
atlas generate video byteplus/video/upscaler -p "Your prompt here"
```

CLI docs: https://www.atlascloud.ai/docs/cli

## HTTP API reference

- **Submit endpoint (POST)**: `https://api.atlascloud.ai/api/v1/model/generateVideo` — start an async generation; returns a `prediction_id`
- **Poll endpoint (GET)**: `https://api.atlascloud.ai/api/v1/model/prediction/{prediction_id}` — poll this until the prediction finishes
- **Model ID**: `byteplus/video/upscaler`


## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:

- **`model`** (`string`, _required_):
  model name
  - Default: `"byteplus/video/upscaler"`

- **`video_url`** (`string`, _required_):
  URL of the source video to enhance. Must be a publicly accessible HTTP(S) URL (user-uploaded or third-party-model output are both supported). Signed URLs should be long-lived — BytePlus fetches the video before processing.

- **`tool_version`** (`string`, _optional_):
  Enhancement engine. professional embeds 30+ algorithms for the strongest quality but costs ~10x standard.
  - Default: `"standard"`
  - Options: "standard", "professional"

- **`scene`** (`string`, _optional_):
  Scene template. Only effective when tool_version=standard.
  - Default: `"common"`
  - Options: "common", "ugc", "short_series", "aigc", "old_film"

- **`resolution`** (`string`, _optional_):
  Target output resolution. Mutually exclusive with resolution_limit — set only one.
  - Default: `"1080p"`
  - Options: "240p", "360p", "480p", "540p", "720p", "1080p", "2k", "4k", "8k"

- **`resolution_limit`** (`integer`, _optional_):
  Target short-edge pixel cap [128, 4320], scaled proportionally. Mutually exclusive with resolution — if resolution is set, this is ignored.
  - Min: 128
  - Max: 4320

- **`bitrate_level`** (`string`, _optional_):
  Target bitrate tier.
  - Default: `"medium"`
  - Options: "low", "medium", "high"

- **`fps`** (`integer`, _optional_):
  Target frame rate [15, 120] (frame interpolation). Omit to keep the source frame rate. Recommended not to exceed 4x the source fps.
  - Min: 15
  - Max: 120

- **`bit_depth`** (`integer`, _optional_):
  Color bit depth. Only effective when tool_version=professional.
  - Default: `8`
  - Options: 8, 10, 12



**Required Parameters Example**:

```json
{
  "model": "byteplus/video/upscaler",
  "video_url": ""
}
```


**Full Example**:

```json
{
  "model": "byteplus/video/upscaler",
  "video_url": "",
  "tool_version": "standard",
  "scene": "common",
  "resolution": "1080p",
  "resolution_limit": 128,
  "bitrate_level": "medium",
  "fps": 15,
  "bit_depth": 8
}
```


### Output Schema

The API returns the following output format:


- **`created_at`** (`string`, _optional_):
  ISO timestamp of when the request was created.

- **`has_nsfw_contents`** (`array[boolean]`, _optional_):
  Array of boolean values indicating NSFW detection for each output.

- **`id`** (`string`, _optional_):
  Unique identifier for the prediction.

- **`model`** (`string`, _optional_):
  Model ID used for the prediction.

- **`outputs`** (`array[string]`, _optional_):
  Array of URLs to the enhanced video(s).

- **`status`** (`string`, _optional_):
  Status of the task: created, processing, completed, or failed.

- **`urls`** (`object`, _optional_):
  Object containing related API endpoints.



**Example Response**:

```json
{
  "created_at": "",
  "has_nsfw_contents": [],
  "id": "",
  "model": "",
  "outputs": [
    ""
  ],
  "status": "",
  "urls": {}
}
```


## Usage Examples

### cURL

```bash
# Step 1: Start generation (async)
curl -X POST "https://api.atlascloud.ai/api/v1/model/generateVideo" \
  -H "Authorization: Bearer $ATLASCLOUD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "byteplus/video/upscaler",
  "video_url": "",
  "tool_version": "standard",
  "scene": "common",
  "resolution": "1080p",
  "resolution_limit": 128,
  "bitrate_level": "medium",
  "fps": 15,
  "bit_depth": 8
}'

# Response will contain: {"code": 200, "data": {"id": "prediction_id", "status": "processing"}}

# Step 2: Poll for result (replace {prediction_id} with the id returned above)
curl -X GET "https://api.atlascloud.ai/api/v1/model/prediction/{prediction_id}" \
  -H "Authorization: Bearer $ATLASCLOUD_API_KEY"

# Keep polling until status is "completed", "succeeded" or "failed"
# When completed, outputs will contain the generated content URL(s)
```

## Additional Resources

### Documentation

- [Model Playground](https://www.atlascloud.ai/models/byteplus/video/upscaler)

## About this model

_Vendor-supplied description. Any pricing or endpoint mentioned below refers to_
_other platforms — use the Atlas Cloud values above._

### BytePlus Video Upscaler

BytePlus Video Upscaler enhances an existing video to a higher output resolution and better quality using BytePlus AI MediaKit super-resolution. Provide a public video URL, pick the engine and target resolution, and receive a playable enhanced video URL.

#### Highlights

- **Video-to-video enhancement:** Improve an existing clip (up to 8K) without changing the source content.
- **Scene-aware standard engine:** `standard` uses a scene template — `common`, `ugc`, `short_series`, `aigc` (AI-generated source), or `old_film` (degraded footage) — for fast, cost-effective results.
- **Professional engine:** `professional` runs 30+ algorithms for the strongest quality (higher latency and ~10x the cost of `standard`).
- **Flexible output control:** Target a fixed resolution (`240p`–`8k`) or a short-edge pixel cap, tune the bitrate tier, and optionally interpolate the frame rate.
- **Hosted output:** Enhanced videos are transferred to AtlasCloud storage and returned as long-lived URLs (the upstream URL expires in 24 hours and is never exposed).

#### Parameters

_(Description truncated. Full text on the model page.)_

---

Atlas Cloud — one API for 400+ AI models. Model page: https://www.atlascloud.ai/models/byteplus/video/upscaler · Docs: https://www.atlascloud.ai/docs