Topaz Video Upscale

POST/v1/run

Upscale Video is Topaz Labs's video-to-video AI model. Transform, enhance, and edit video content using text prompts - from style changes to object manipulation and scene modification.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to topaz/upscale/video.

Default: topaz/upscale/video

Optional<string>video

URL of the video to upscale

Optional<number>noise

Noise reduction level (0.0-1.0). Default varies by model.

Range: 0 to 1

Optional<number>upscale_factor

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

Range: 1 to 4

Default: 2

Optional<number>halo

Halo reduction level (0.0-1.0). Default varies by model.

Range: 0 to 1

Optional<number>compression

Compression artifact removal level (0.0-1.0). Default varies by model.

Range: 0 to 1

Optional<number>grain

Film grain amount (0.0-0.1). Default varies by model.

Range: 0 to 0.1

Optional<number>recover_detail

Recover original detail level (0.0-1.0). Higher values preserve more original detail.

Range: 0 to 1

Optional<integer>target_fps

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

Range: 16 to 60

Optional<boolean>H264_output

Whether to use H264 codec for output video. Default is H265.

Default: false

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: video-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async

# 1. Submit a generation request
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "topaz/upscale/video",
  "video": "https://static.sandbase.ai/examples/topaz/upscale/video/input_video_0.mp4"
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "model": "topaz/upscale/video",
  "status": "running"
}