API reference · Topaz Labs

topaz/upscale/video

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

VIDEOAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDtopaz/upscale/video

Input Schema

9 parameters · 0 required · 9 optional

Parameter	Type	Required	Description
`halo`	number	Optional	Halo reduction level (0.0-1.0). Default varies by model. · Min: 0 · Max: 1
`grain`	number	Optional	Film grain amount (0.0-0.1). Default varies by model. · Min: 0 · Max: 0.1
`noise`	number	Optional	Noise reduction level (0.0-1.0). Default varies by model. · Min: 0 · Max: 1
`video`	string	Optional	URL of the video to upscale
`target_fps`	integer	Optional	Target FPS for frame interpolation. If set, frame interpolation will be enabled. · Min: 16 · Max: 60
`H264_output`	boolean	Optional	Whether to use H264 codec for output video. Default is H265. · Default: false
`compression`	number	Optional	Compression artifact removal level (0.0-1.0). Default varies by model. · Min: 0 · Max: 1
`recover_detail`	number	Optional	Recover original detail level (0.0-1.0). Higher values preserve more original detail. · Min: 0 · Max: 1
`upscale_factor`	number	Optional	Factor to upscale the video by (e.g. 2.0 doubles width and height) · Min: 1 · Max: 4 · Default: 2

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, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "topaz/upscale/video",
    "video": "https://static.sandbase.ai/examples/topaz/upscale/video/input_video_0.mp4",
    "H264_output": false,
    "upscale_factor": 2
  }),
});

if (!response.ok) throw new Error(await response.text());
let result = await response.json();
for (let attempt = 0; attempt < 120 && !["completed", "failed", "timeout"].includes(result.status); attempt++) {
  await new Promise((resolve) => setTimeout(resolve, 2_000));
  const poll = await fetch(`https://api.sandbase.ai/v1/run/${result.id}`, {
    headers: { Authorization: `Bearer ${apiKey}` },
  });
  if (!poll.ok) throw new Error(await poll.text());
  result = await poll.json();
}
if (result.status !== "completed") throw new Error(`Generation ended: ${result.status}`);
console.log(result);

← Back to Topaz Video Upscale