Topaz - Video 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 video 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/video-upscale for this endpoint Default："topaz/video-upscale"。 Allowed values：topaz/video-upscale。 示例：topaz/video-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	Yes	Input parameters for the generation task
input.video_url	string	Yes	URL of the video to upscale (File URL after upload, not file content; Accepted types: video/mp4, video/quicktime, video/x-matroska; Max size: 50.0MB) 示例：https://file.aiquickdraw.com/custom-page/akr/section-images/1758166466095hvbwkrpw.mp4。
input.upscale_factor	string	No	Upscale factor (string): "1", "2" (default) or "4". 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/video-upscale",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "video_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1758166466095hvbwkrpw.mp4",
    "upscale_factor": "2"
  }
}'

{
  "model": "topaz/video-upscale",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "video_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1758166466095hvbwkrpw.mp4",
    "upscale_factor": "2"
  }
}

Response

200 — Request successful

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

500 — Server error.

参数	类型	必填	说明
code	integer	是	Response status code - 200: Success - Request has been processed successfully - 401: Unauthorized - Authentication credentials are missing or invalid - 402: Insufficient Credits - Account does not have enough credits to perform the operation - 404: Not Found - The requested resource or endpoint does not exist - 408: Timeout - No result has been returned for over 10 minutes. - 422: Validation Error - The request parameters failed validation checks - 429: Rate Limited - Request limit has been exceeded for this resource - 455: Service Unavailable - System is currently undergoing maintenance - 500: Server Error - An unexpected error occurred while processing the request - 501: Generation Failed - Content generation task failed - 505: Feature Disabled - The requested feature is currently disabled
msg	string	是	Response message, error description when failed
data	object	是	—

{
  "code": 500,
  "msg": "Server Error - An unexpected error occurred while processing the request",
  "data": null
}

Callback

videoTaskCompleted

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

The system sends this callback when the topaz/video-upscale task succeeds or fails.

Callback body parameters

参数	类型	必填	说明
code	integer	是	Unified callback code: 200 for success, 501 for failure. Allowed values：200 / 501。 示例：200。
msg	string	是	Unified callback message. Allowed values：Playground task completed successfully. / Playground task failed.。 示例：Playground task completed successfully.。
data	object	是	—
data.taskId	string	是	The unique task identifier.
data.model	string	是	The model used for the task. Allowed values：topaz/video-upscale。 示例：topaz/video-upscale。
data.state	string	是	Terminal task state. Allowed values：success / fail。 示例：success。
data.param	string	是	JSON string containing the submitted task parameters.
data.resultJson	string	否	JSON string containing resultUrls, firstFrameUrl, lastFrameUrl, or resultObject when successful. Present only when state is success.
data.failCode	string	否	Failure code, a numeric string such as "400" or "500". Present only when state is fail.
data.failMsg	string	否	Failure reason. Present only when state is fail.
data.costTime	integer	否	Processing time in seconds. Present on both success and failure callbacks.
data.completeTime	integer	否	Task completion timestamp.
data.createTime	integer	否	Task creation timestamp.
data.updateTime	integer	否	Use completeTime as the completion time; updateTime may equal createTime.
data.creditsConsumed	number	否	Credits consumed by the task; 0 for failed tasks.

Task completed successfully

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "task_example_video_webhook_001",
    "model": "topaz/video-upscale",
    "state": "success",
    "param": "{\"input\":\"{\\\"video_url\\\":\\\"https://example.com/input-video.mp4\\\",\\\"upscale_factor\\\":\\\"2\\\"}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"topaz/video-upscale\"}",
    "resultJson": "{\"resultUrls\":[\"https://example.com/generated-video.mp4\"]}",
    "costTime": 12,
    "completeTime": 1234567890,
    "createTime": 1234560000,
    "updateTime": 1234567890,
    "creditsConsumed": 1.23
  }
}

Task failed

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "task_example_video_webhook_001",
    "model": "topaz/video-upscale",
    "state": "fail",
    "param": "{\"input\":\"{\\\"video_url\\\":\\\"https://example.com/input-video.mp4\\\",\\\"upscale_factor\\\":\\\"2\\\"}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"topaz/video-upscale\"}",
    "failCode": "400",
    "failMsg": "<error detail>",
    "costTime": 12,
    "creditsConsumed": 0
  }
}