模型 API 接入文档
Topaz Image Upscaler API 接入文档
通过 Rivya Public API v1 调用 Topaz Image Upscaler,包含模型 ID topaz-image-upscale、输入类型、参数、Files API 规则、积分和响应示例。
API 可调用可用状态图片
API 模型 ID
topaz-image-upscale
输入类型
file
Files API
参考素材模式需要
基础积分
per_image · 2K=10 · 4K=20 · 8K=40 · ⌈total⌉
能力类型
图片
计费方式
FIXED
提示词上限
未配置提示词上限
请求字段
模型 ID 放在顶层字段。模型专属控制项放入 params。
| Key | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| model | string | 是 | topaz-image-upscale | 使用 topaz-image-upscale 作为 API 模型 ID。 |
| prompt | string | 否 | - | 支持文本输入的模型使用这个字段传入提示词。 |
| params | object | 否 | - | 模型专属参数对象。可用 key 见下方参数表。 |
| client_request_id | string | 否 | - | 可选客户端请求 ID,便于你在自己的系统中追踪请求。 |
模型参数
| Key | 类型 | 必填 | 默认值 | 范围 | 枚举值 | 说明 |
|---|---|---|---|---|---|---|
| upscale_factor | select | 否 | 2 | - | 1, 2, 4 | 放大倍数 |
上传策略
先上传参考文件,再把返回的 URL 和 durationToken 放入 params.referenceMediaItems。
参考素材规则
源图片: 仅限 1 张 JPEG、PNG 或 WebP 图片,最大 10 MB;输出最长边 ≤ 8192 px。
最大文件数
1
支持文件类型
image
Duration token
视频和音频参考素材需要时长校验时,应携带 /api/v1/files 返回的 durationToken。
| kind | 大小上限 | MIME 类型 |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
最小请求
{
"model": "topaz-image-upscale",
"params": {
"upscale_factor": "2"
}
}参考文件请求
{
"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"
}
]
}
}创建响应
创建接口会返回公开任务 ID。继续轮询状态接口,直到任务成功或失败。
{
"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
}常见错误
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
部分模式需要通过 Files API 上传参考素材。
