Topaz Video Upscaler API Integration
Use Topaz Video Upscaler through Rivya Public API v1 with model id topaz-video-upscale, supported inputs, parameters, Files API rules, credits, and response examples.
topaz-video-upscale
file
Required for reference modes
per_input_second · 1x_or_2x=8 · 4x=14 · ⌈total⌉
Video
METERED
No documented prompt limit
Request contract
Send the model id at the top level. Model-specific controls belong in params.
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | topaz-video-upscale | Use the topaz-video-upscale API model id. |
| prompt | string | No | - | Prompt text for models that support text input. |
| params | object | No | - | Model-specific parameter object. Use the rows below for allowed keys. |
| client_request_id | string | No | - | Optional client-side id for tracing requests in your system. |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| upscale_factor | select | No | 2 | - | 1, 2, 4 | Upscale factor |
Upload policy
Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.
Source video: Rivya accepts one MP4, MOV, or MKV file up to 10MB; the upstream interface allows 50MB, so Rivya uses the stricter limit.
1
video
Video and audio references should carry durationToken from /api/v1/files when duration verification is required.
| kind | Max size | MIME types |
|---|---|---|
| video | 10 MB | video/mp4, video/quicktime, video/x-matroska |
Minimal request
{
"model": "topaz-video-upscale",
"params": {
"upscale_factor": "2"
}
}Reference-file request
{
"model": "topaz-video-upscale",
"params": {
"upscale_factor": "2",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-video.mp4",
"kind": "video",
"name": "reference-video.mp4",
"mimeType": "video/mp4",
"durationSeconds": 8,
"durationToken": "video_duration_token_from_files_api"
}
]
}
}Create response
The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.
{
"id": "task_topaz_video_upscale_example",
"status": "queued",
"model": "topaz-video-upscale",
"reserved_credits": 8,
"final_credits": 0,
"settlement_status": "RESERVED",
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}Common errors
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Some modes require Files API reference uploads.
