Topaz Image Upscaler API reference
Check Topaz Image Upscaler availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: topaz-image-upscale.
topaz-image-upscale
file
Required for reference modes
Credit rate: 10–20 per image The final cost is rounded up to whole credits.
Image
FIXED
No documented prompt limit
Request fields
Set model at the top level. Put model-specific controls and reference inputs in params, using the format documented for this model.
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | topaz-image-upscale | Set model to topaz-image-upscale. |
| prompt | string | No | - | Prompt text for models that support text input. |
| params | object | Yes | - | The model-specific params object. Use the documented keys and reference-file format for this model. |
| client_request_id | string | No | - | Optional ID for tracing this request in your system. It does not replace Idempotency-Key. |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| upscale_factor | select | No | 2 | - | 1, 2, 4 | Upscale factor |
Upload policy
Upload reference files through Files API first. Keep the original URLs, verified metadata, and tokens. Follow this model's request example: some models use params.referenceMediaItems, while others use different fields.
Source image: Exactly 1 JPEG, PNG, or WebP image up to 10 MB; output longest edge ≤ 4096 px. This is Rivya’s currently supported output range.
1
image
When duration verification is required, use duration_token from /api/v1/files as durationToken in the request. Keep any additional signed metadata this model requires.
| kind | Max size | MIME types |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
No runnable Public API example is shown for this model.
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"
}
]
}
}Example response
An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.
{
"id": "task_topaz_image_upscale_example",
"status": "queued",
"model": "topaz-image-upscale",
"reserved_credits": 10,
"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.
