↓
Rivya AI Docs
Model API Pages

Topaz Image Upscaler API Integration

Use Topaz Image Upscaler through Rivya Public API v1 with model id topaz-image-upscale, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIReadinessImage
API model id

topaz-image-upscale

Inputs

file

Files API

Required for reference modes

Base credits

per_image · 2K=10 · 4K=20 · 8K=40 · ⌈total⌉

Capability

Image

Billing

FIXED

Prompt limit

No documented prompt limit

Request contract

Send the model id at the top level. Model-specific controls belong in params.

KeyTypeRequiredDefaultDescription
modelstringYestopaz-image-upscaleUse the topaz-image-upscale API model id.
promptstringNo-Prompt text for models that support text input.
paramsobjectNo-Model-specific parameter object. Use the rows below for allowed keys.
client_request_idstringNo-Optional client-side id for tracing requests in your system.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
upscale_factorselectNo2-1, 2, 4Upscale factor

Upload policy

Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.

Reference rule

Source image: Exactly 1 JPEG, PNG, or WebP image up to 10 MB; output longest edge ≤ 8192 px.

Max files

1

Accepted file kinds

image

Duration token

Video and audio references should carry durationToken from /api/v1/files when duration verification is required.

kindMax sizeMIME types
image10 MBimage/jpeg, image/png, image/webp

Minimal request

{
  "model": "topaz-image-upscale",
  "params": {
    "upscale_factor": "2"
  }
}

Reference-file request

{
  "model": "topaz-image-upscale",
  "params": {
    "upscale_factor": "2",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png",
        "width": 1024,
        "height": 1024,
        "sizeBytes": 1048576,
        "imageDimensionsToken": "image_dimensions_token_from_original_files_api_upload_response"
      }
    ]
  }
}

Create response

The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.

{
  "id": "task_topaz_image_upscale_example",
  "status": "queued",
  "model": "topaz-image-upscale",
  "reserved_credits": 40,
  "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.