Topaz 图像优化

本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致；品牌与 API 域名已替换为 ModelFold。

接口

POST /jobs/createTask

完整 URL: https://ai.modelfold.online/v1/jobs/createTask

鉴权：所有请求都需要 Authorization: Bearer <API_KEY> 请求头。

基于 Topaz 先进的 AI 放大技术，提升图像分辨率与画质

查询任务状态

提交任务后，可通过统一的查询端点查看任务进度并获取处理结果：

• 获取任务详情 — 了解如何查询任务状态并获取图像放大结果

TIP

生产环境中，建议使用 callBackUrl 参数接收任务完成的自动通知，而非轮询状态端点。

相关资源

• 市场概览 — 浏览所有可用模型
• 通用 API — 查看账户积分与使用情况

请求参数

请求体 (application/json)

参数	类型	必填	说明
model	string	是	用于处理任务的模型名称。必填字段。 - 该端点必须使用 topaz/image-upscale 模型 默认值："topaz/image-upscale"。 可选值：topaz/image-upscale。 示例：topaz/image-upscale。
callBackUrl	string	否	接收任务完成通知的回调 URL。可选配置，建议在生产环境中使用。 - 任务处理完成后，系统会向该 URL POST 任务状态与结果 - 回调内容包含处理后的资源 URL 与任务相关信息 - 您的回调端点需要支持接收带 JSON 负载的 POST 请求 - 也可以选择调用任务详情端点，主动轮询任务状态 - 为确保回调安全性，请参阅 Webhook 校验指南 了解签名验证实现方法 示例：https://your-domain.com/api/callback。
input	object	否	图像放大任务的输入参数
input.image_url	string	是	待放大图像的 URL（为上传后的文件 URL，而非文件内容；支持类型：image/jpeg、image/png、image/webp；最大大小：10.0MB） 示例：https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png。
input.upscale_factor	string	是	图像放大倍数（例如 2.0 表示将宽度和高度都放大至原来的 2 倍） 默认值："2"。 可选值：1 / 2 / 4。 示例：2。

请求示例

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "topaz/image-upscale",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "image_url": "https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png",
    "upscale_factor": "2"
  }
}'

{
  "model": "topaz/image-upscale",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "image_url": "https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png",
    "upscale_factor": "2"
  }
}

响应

200 — 请求成功

参数	类型	必填	说明
code	integer	是	请求状态码。请求失败时 HTTP 状态仍为 200，请始终以本字段判断：200 表示成功，其他值均表示失败，原因见 msg。常见值：401 API key 无效或缺失；402 积分不足；429 超出频率限制；422 或 500 请求未能处理（请先查看 msg、检查参数，再决定是否重试）。 可选值：200 / 401 / 402 / 404 / 422 / 429 / 433 / 455 / 500 / 501 / 505。 示例：200。
msg	string	是	响应消息，失败时的错误描述
data	object	是	—
data.taskId	string	是	可以使用任务 ID 与“获取任务详细信息”端点一起查询任务状态。

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_topaz_1765176093786"
  }
}

回调

onImageGenerated

回调地址：{$request.body#/callBackUrl}（即请求体里的 callBackUrl）。

任务成功或失败时发送回调。

回调体参数

参数	类型	必填	说明
code	integer	否	200：成功；501：失败，原因见 data.failCode 与 data.failMsg。 可选值：200 / 501。 示例：200。
msg	string	否	状态消息 示例：Playground task completed successfully.。
data	object	否	—
data.completeTime	integer	否	任务完成时间，Unix 毫秒时间戳 示例：1786433399000。
data.costTime	integer	否	处理耗时（秒），成功和失败回调都会返回。 示例：72。
data.createTime	integer	否	任务创建时间，Unix 毫秒时间戳 示例：1786433326000。
data.creditsConsumed	number	否	本任务消耗的积分；失败任务为 0。 示例：10。
data.model	string	否	图片放大使用的模型 示例：topaz/image-upscale。
data.param	string	否	创建任务时提交的参数，JSON 字符串格式 示例：{"input":"{\"upscale_factor\":\"2\",\"image_url\":\"https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png\"}","callBackUrl":"https://your-domain.com/api/callback","model":"topaz/image-upscale"}。
data.resultJson	string	否	图片放大结果，JSON 字符串格式。resultUrls 为生成图片的 URL 列表。仅在 state 为 success 时出现。 示例：{"resultUrls":["https://tempfile.aiquickdraw.com/h/ea2e1877719c0f0deac55d0a9d6cf7ef_1786433397.png"]}。
data.state	string	否	任务状态 可选值：success / fail。 示例：success。
data.taskId	string	否	任务 ID 示例：ea2e1877719c0f0deac55d0a9d6cf7ef。
data.updateTime	integer	否	完成时间请以 completeTime 为准；updateTime 可能与 createTime 相同。 示例：1786433399000。
data.failCode	string	否	失败码，数字字符串，如 "400"、"500"。仅在 state 为 fail 时出现。 示例：500。
data.failMsg	string	否	失败原因，仅在 state 为 fail 时出现。 示例：<error detail>。

成功

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "ea2e1877719c0f0deac55d0a9d6cf7ef",
    "model": "topaz/image-upscale",
    "state": "success",
    "param": "{\"input\":\"{\\\"upscale_factor\\\":\\\"2\\\",\\\"image_url\\\":\\\"https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"topaz/image-upscale\"}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/h/ea2e1877719c0f0deac55d0a9d6cf7ef_1786433397.png\"]}",
    "completeTime": 1786433399000,
    "createTime": 1786433326000,
    "costTime": 72,
    "creditsConsumed": 10,
    "updateTime": 1786433399000
  }
}

失败

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "ea2e1877719c0f0deac55d0a9d6cf7ef",
    "model": "topaz/image-upscale",
    "state": "fail",
    "param": "{\"input\":\"{\\\"upscale_factor\\\":\\\"2\\\",\\\"image_url\\\":\\\"https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"topaz/image-upscale\"}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786433399000,
    "createTime": 1786433326000,
    "costTime": 72,
    "creditsConsumed": 0,
    "updateTime": 1786433399000
  }
}