API reference · Bytedance
bytedance/upscaler/video
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
bytedance/upscaler/video01
Input Schema
7 parameters · 0 required · 7 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
video | string | Optional | The URL of the video to upscale. |
fidelity | string | Optional | The enhancement intensity. 'high' applies mild enhancement while keeping visual texture close to the source video. 'medium' provides a balanced image quality enhancement. · Options: high, medium · Default: "high" highmedium |
target_fps | string | Optional | The target FPS of the video to upscale. · Options: 30fps, 60fps · Default: "30fps" 30fps60fps |
scale_ratio | number | Optional | 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). · Min: 1.1 · Max: 10 |
enhancement_tier | string | Optional | 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`. · Options: fast, standard, pro · Default: "standard" faststandardpro |
target_resolution | string | Optional | The target resolution of the video to upscale. · Options: 1080p, 2k, 4k · Default: "1080p" 1080p2k4k |
enhancement_preset | string | Optional | 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. · Options: general, ugc, short_series, aigc, old_film · Default: "general" generalugcshort_seriesaigcold_film |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
Async Workflow
This model uses asynchronous execution. Submit a request and poll for the result.
- Submit — POST to /v1/run, receive an
id - Poll — GET /v1/run/{id} until status is
completed,failed, ortimeout - Retrieve — Read
outputsfrom the completed response
03
Code Examples
Ready-to-run snippets
# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "bytedance/upscaler/video",
"video": "https://static.sandbase.ai/examples/bytedance/upscaler/video/input_video_0.mp4",
"fidelity": "high",
"target_fps": "30fps",
"enhancement_tier": "standard",
"target_resolution": "1080p",
"enhancement_preset": "general",
"prompt": "a beautiful sunset over mountains"
}'
# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
-H "Authorization: Bearer YOUR_API_KEY"
