Topaz Video Upscaler API 接入文档
使用 VezAPI 密钥接入 Topaz Video Upscaler。下列操作共用同一个账号余额和鉴权方式。
https://api.vezapi.com请求头使用 Authorization: Bearer YOUR_VEZAPI_KEY。每次提交使用唯一的 Idempotency-Key,查询同一笔提交时才复用。
Topaz视频优化
/api/v1/jobs/createTask模型标识: topaz/video-upscale
| 参数 | 类型 | 说明与限制 |
|---|---|---|
model必填 | string | 用于处理任务的模型名称。必填字段。 - 该接口必须使用 `topaz/video-upscale` 模型 可选值: 默认: |
callBackUrl可选 | string | 接收处理任务完成通知的回调 URL。可选配置,生产环境建议使用。 - 任务处理完成后,系统会向该 URL 以 POST 方式推送任务状态和结果 - 回调内容包含处理后内容的 URL 及任务相关信息 - 你的回调接口需支持接收 POST 请求及 JSON 格式的请求体 - 也可选择调用任务详情接口,主动轮询任务状态 - 为确保回调安全性,请参阅 [Webhook 校验指南](/cn/common-api/webhook-verification) 了解签名验证实现方法 |
input必填 | object | 处理任务的输入参数 |
input.video_url必填 | string | 待超分放大的视频 URL(需为上传后的文件 URL,而非文件内容;支持的格式:video/mp4、video/quicktime、video/x-matroska;最大文件大小:50.0MB) |
input.upscale_factor可选 | string | 放大倍数(字符串):"1"、"2"(默认)、"4"。 可选值: 默认: |
请求示例
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
-H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
-H 'Idempotency-Key: your-unique-request-id' \
-H 'Content-Type: application/json' \
-d '{
"model": "topaz/video-upscale",
"input": {
"video_url": "https://example.com/input.png"
}
}'返回值与错误
HTTP 200
请求成功
| 参数 | 类型 | 说明与限制 |
|---|---|---|
code可选 | integer | Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying). 可选值: |
msg可选 | string | Response message, error description upon failure |
data必填 | object | |
data.taskId必填 | string | The task ID can be used with the "Get Task Details" endpoint to query the task status. |
HTTP 500
响应字段与业务状态码。
| 参数 | 类型 | 说明与限制 |
|---|---|---|
code必填 | integer | 业务状态码:200 请求成功;401 鉴权凭据缺失或无效;402 积分不足;404 资源或接口不存在;408 超过 10 分钟未返回结果;422 参数校验失败;429 请求频率超限;455 系统维护;500 处理请求时发生内部错误;501 内容生成失败;505 功能当前关闭。 |
msg必填 | string | 响应消息;失败时说明错误原因。 |
data必填 | object |
任务状态与回调
异步任务请保存返回的 taskId。调用 GET /api/v1/jobs/recordInfo?taskId=... 查询,或在创建时设置 callBackUrl。只有任务所属账号可以查询任务或基于任务创建派生资源。
超时可能表示请求已经受理。请在控制台查看原请求,不要自动新建任务。回调可能重试并重复到达,请使用 X-VezAPI-Event-Id 去重。
文件、日志与计费
生成媒体通常随上游保留 14 天,上传文件在 24 小时后失效。请在过期前保存所需文件。VezAPI 仅流式转发已登记资源,不提供永久作品库。请求日志保留两个自然月。
调用前预留积分,最终按实际优惠扣分 1:1 结算。用量不明时暂停新付费请求。若保护其他任务预留后余额不足以结算,会保留待结算记录,补足余额后再扣费;模型用量不会将钱包扣成负数。按时长计价的输入文件由服务端读取时长,读取失败时不提交模型任务。