Image Upscaler API documentation
Enhance and upscale one image by 2× or 4×.
Endpoints
| Contract item | Value |
|---|---|
| Capability | image-upscaler |
| Submit | POST https://vidmage.ai/api/v1/image-upscaler/submit |
| Query | POST https://vidmage.ai/api/v1/image-upscaler/query |
| Task identifier | taskId |
| Result field | imageUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: AI Image Upscaler API for 2x and 4x Requests
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
imageURL | string | Yes | Not specified | URL of the source image. |
scale | integer | Yes | Not specified | Upscale factor. Values: 2, 4 |
Example request
{
"imageURL": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
"scale": 2
}# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/image-upscaler/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"imageURL":"https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp","scale":2}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Task results and recovery
URL of the upscaled image. Read imageUrl from the completed query response. Preserve taskId while the task is running.
curl -X POST "https://vidmage.ai/api/v1/image-upscaler/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| Per request | 1 credits / image | — |
A fixed credit charge applies to this API request.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.