Skip to content
中文

VezAPI Image Upscaler API documentation

Integrate VezAPI Image Upscaler with your VezAPI key. The operations below share the same authentication and account balance.

Image upscaling reserves the maximum published tier of 12 credits per image before submission. Final deductions match actual consumption; unused reservations are released.

Base URL: https://api.vezapi.com
Send Authorization: Bearer YOUR_VEZAPI_KEY. Use a unique Idempotency-Key for each submission; reuse it only when checking the same request.

VezAPI - Image Upscale

POST/api/v1/jobs/createTask

Model IDs: kie/image-upscale

ParameterTypeDescription & constraints
model
required
string

The model name to use for generation. Required field. - Must be `kie/image-upscale` for this endpoint

Values: "kie/image-upscale"

Default: "kie/image-upscale"

callBackUrl
optional
string

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 - Callbacks may be delivered more than once — deduplicate by `taskId` - To ensure callback security, see [Webhook Verification Guide](/common-api/webhook-verification) for signature verification implementation

input
required
object

Input parameters for the upscale task

input.image_url
required
string

URL of the image to upscale. Required. - Must be a publicly downloadable HTTP(S) URL - Max file size: 20 MB - Supported formats: JPG, PNG, WEBP, HEIC, BMP, GIF (only the first frame is used) - Use a file URL after upload, not the file content itself

input.upscale_factor
optional
string

Upscale factor applied to both width and height, keeping the aspect ratio. Optional. Allowed values: `"1"`, `"2"`, `"4"`, `"8"` (numbers are also accepted). Default: `"2"`. - `1`: same-size quality enhancement (denoise, sharpen, preserve text); dimensions do not change - `2` / `4` / `8`: output width and height = input × factor - Output must stay within 67 MP (about 8192×8192) and 16,384 px per side; otherwise the request is rejected with 422 and not charged - Billing tier (2K / 4K / 8K) is determined by the total output pixels

Values: "1", "2", "4", "8"

Default: "2"

Request example
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": "kie/image-upscale",
  "input": {
    "image_url": "https://example.com/input.png"
  }
}'
Responses and errors

HTTP 200

Request successful

ParameterTypeDescription & constraints
code
optional
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).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional
string

Response message, error description upon failure

data
required
object
data.taskId
required
string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

HTTP 500

Server error.

ParameterTypeDescription & constraints
code
required
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
required
string

Response message, error description when failed

data
required
object

Task status and callbacks

For asynchronous tasks, keep the returned taskId. Query GET /api/v1/jobs/recordInfo?taskId=... or provide callBackUrl when creating the task. Only the account that created a task can access it or derive new resources from it.

A timeout can mean the submission was accepted. Inspect the existing request in your dashboard; do not create another task automatically. Callback delivery is retried and may arrive more than once. Deduplicate with X-VezAPI-Event-Id.

Files, logs and billing

Generated media normally follows a 14-day provider lifetime; uploaded files expire after 24 hours. Save the files you need before expiration. VezAPI streams registered files without keeping a permanent media library. Request logs are retained for two calendar months.

Credits are reserved before submission. Final deductions match actual discounted consumption one for one. Unknown usage pauses new paid requests. If available funds cannot cover final usage while protecting other reservations, settlement stays pending until funded; model usage cannot make the wallet negative. Time-based inputs require server-side metadata reads; a failed read prevents submission.