Topaz - Image Upscale

This page is generated from the upstream official OpenAPI documentation. Endpoints, parameters and examples match the official docs; brand and API domain are replaced with ModelFold.

Endpoint

POST /jobs/createTask

Full URL: https://ai.modelfold.online/v1/jobs/createTask

Authentication: every request must include the Authorization: Bearer <API_KEY> header.

Enhance image resolution and quality using advanced AI upscaling powered by Topaz

Query Task Status

After submitting a task, use the unified query endpoint to check progress and retrieve results:

• Get Task Details — Learn how to query task status and retrieve generation results

TIP

For production use, we recommend using the callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.

Related Resources

• Market Overview — Explore all available models
• Common API — Check credits and account usage

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
model	string	Yes	The model name to use for generation. Required field. - Must be topaz/image-upscale for this endpoint Default："topaz/image-upscale"。 Allowed values：topaz/image-upscale。 示例：topaz/image-upscale。
callBackUrl	string	No	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see Webhook Verification Guide for signature verification implementation 示例：https://your-domain.com/api/callback。
input	object	No	Input parameters for the generation task
input.image_url	string	Yes	Url of the image to be upscaled (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) 示例：https://static.aiquickdraw.com/tools/example/1762752805607_mErUj1KR.png。
input.upscale_factor	string	Yes	Factor to upscale the image by (e.g. 2 doubles width and height). Default："2"。 Allowed values：1 / 2 / 4。 示例：2。

Request Example

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"
  }
}

Response

200 — Request successful

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

Callback

onImageGenerated

Callback URL: {$request.body#/callBackUrl} (the callBackUrl in the request body).

Sent when the task succeeds or fails.

Callback body parameters

参数	类型	必填	说明
code	integer	否	200: success. 501: failure; see data.failCode and data.failMsg. Allowed values：200 / 501。 示例：200。
msg	string	否	Status message 示例：Playground task completed successfully.。
data	object	否	—
data.completeTime	integer	否	Task completion time, represented as a Unix timestamp in milliseconds 示例：1786433399000。
data.costTime	integer	否	Processing time in seconds. Present on both success and failure callbacks. 示例：72。
data.createTime	integer	否	Task creation time, represented as a Unix timestamp in milliseconds 示例：1786433326000。
data.creditsConsumed	number	否	Credits consumed by the task; 0 for failed tasks. 示例：10。
data.model	string	否	Image upscaling model used for the task 示例：topaz/image-upscale。
data.param	string	否	Parameters submitted when creating the task, in JSON string format 示例：{"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	否	Image upscaling result in JSON string format. resultUrls contains the list of generated image URLs. Present only when state is success. 示例：{"resultUrls":["https://tempfile.aiquickdraw.com/h/ea2e1877719c0f0deac55d0a9d6cf7ef_1786433397.png"]}。
data.state	string	否	Task status Allowed values：success / fail。 示例：success。
data.taskId	string	否	Task ID 示例：ea2e1877719c0f0deac55d0a9d6cf7ef。
data.updateTime	integer	否	Use completeTime as the completion time; updateTime may equal createTime. 示例：1786433399000。
data.failCode	string	否	Failure code, a numeric string such as "400" or "500". Present only when state is fail. 示例：500。
data.failMsg	string	否	Failure reason. Present only when state is fail. 示例：<error detail>。

Success

{
  "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
  }
}

Failure

{
  "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
  }
}