VidMage

VidMage is an AI video and image creation platform for creators. Turn your ideas and images into videos and fresh visuals.

Open the creator tools
Explore APIs
AI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
Build with VidMage
QuickstartAPI keysVidMage MCPError reference
Your account
Developer consoleAbout VidMagePlans and creditsAPI billingContact support
© 2026 VidMage. All rights reserved.
Privacy PolicyTerms of ServiceReport Abuse
Skip to content
VidMage/Developers
Overview
APIs
All APIsAI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
DocumentationVidMage MCPOpen console
Developers/AI Image Upscaler API for 2x and 4x Requests

AI Image Upscaler API for 2x and 4x Requests

Integrate image upscaling into your editor or asset pipeline. Submit a source image URL, choose a 2x or 4x scale, and retrieve the enlarged image for your application.

Get API keyView API docs
Abstract illustration for AI Image Upscaler API for 2x and 4x Requests
PlaygroundAPIPricingGuideFAQs

AI Image Upscaler API Playground

Use your existing API key and subscription. Submitting a generation uses credits; uploading and preparing a request does not start a generation.

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

2 parameters

URL of the source image.

Upscale factor.

Request code

#!/usr/bin/env bash
set -euo pipefail
# Set this once per intended task; preserve it and the body for transport retries.
: "${VIDMAGE_IDEMPOTENCY_KEY:?Set a unique key for this task}"

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/image-upscaler/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "imageURL": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
  "scale": 2
}')"
TASK_ID="$(printf '%s' "$SUBMIT_RESPONSE" | jq -er '.["taskId"]')"

while true; do
  QUERY_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/image-upscaler/query" \
    -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
    -H "Content-Type: application/json" \
    --data-raw "{\"taskId\":\"${TASK_ID}\"}")"
  STATUS="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.status // .data.status // "") | ascii_downcase')"
  case "$STATUS" in
    success|succeeded|completed)
      RESULT="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["imageUrl"] // .data["imageUrl"] // empty)')"
      if [ -z "$RESULT" ]; then
        printf '%s' "Result missing; preserve task $TASK_ID and query the same task again. Do not resubmit." >&2
        exit 2
      fi
      printf '%s\n' "$RESULT"
      break
      ;;
    needs_input)
      printf '%s' "Face selection required; preserve task $TASK_ID" >&2
      exit 2
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

Response data

Submit the task to see the API response here.
PlaygroundCapabilities

API documentation

Submit a request, track the task, and retrieve your result.

Required inputs
imageURL scale
Output
Image·imageUrl
Request setup & limitsHeaders, input options and media limits

Request headers

Authorization
Bearer YOUR_API_KEY

Keep your API key on your server.

Content-Type
application/json
Idempotency-Key
YOUR_UNIQUE_KEY

Use a new key per task. Reuse it only when retrying the same submission.

Input options & limits

Request controls follow each task's parameter rules; they do not guarantee output properties.

Image Upscaler

RequiredimageURL scale
Request controls
  • scale: 2, 4

Input retention and output-link lifetime depend on the API contract. Confirm API-specific retention terms before making promises to your users. Upload guide ↗

Image Upscaler

POST /api/v1/image-upscaler/submit

Full API documentation ↗

imageURL is required and scale is required.

Required inputs

imageURLstring
URL of the source image.
scalenumber
Upscale factor.

Edit the sample inputs for your own task before submitting.

Image Upscaler request
# 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": ... }
Parameters and input rules2 fields
FieldTypeRequiredDefaultMeaning and limits
imageURLstringYesNot specifiedURL of the source image. No additional field constraint listed.
scalenumberYesNot specifiedUpscale factor. Values: 2, 4 · Whole numbers only

Retrieve the result

Save taskId from the accepted submission and send it to this endpoint:

POST /api/v1/image-upscaler/query

Use the same Bearer API key. On completion, read the imageUrl result field.

Task states and recovery ↗
Image Upscaler query
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://..." } }

Pricing

See what one image, video, or generation costs in credits. Your API and website activity share the same credit balance.

API credit rates and calculated example request costs
API / workflowExample requestPrice (credits)
Image Upscalerimage API1 image request: 1 credit
How this is calculated
  • Per request: 1 credit / image

A fixed credit charge applies to this API request.

Estimate your own request ↗
1 credit / imageSee calculation details
Billed in credits. Shared with the website.Active subscription required. Unit rates and examples follow current API credit rules.Billing details⌄

Examples show the charge for the inputs listed above. Resolution, duration, audio, output count and reference media can change the total. Minimum charges and rounding follow the selected API.

Use the Playground to estimate your request before submitting it. Estimates do not start a generation. Subscription and credit-pack prices are listed on the plans page.

Your task’s recorded usage is the source of truth for the final charge.

View plans ↗Billing guide ↗

About AI Image Upscaler API

VidMage's AI Image Upscaler API is an image processing interface for enlarging images by a requested factor of 2x or 4x. It accepts a source image and a scale setting, then returns an enlarged image. The result can be compared with the source for larger display or editing workflows. To enlarge an image in your browser, use VidMage's Image Upscaler.

AI Image Upscaler API capabilities

2x enlargement requests
Select a numeric scale of 2 to request an enlarged version of the supplied source image.
4x enlargement requests
Select a numeric scale of 4 when your workflow calls for the larger supported enlargement factor.
Image pipeline output
Retrieve the enlarged image and inspect it alongside the original before adding it to an asset pipeline.

What you can build

Larger product galleries

Give merchants a 2x or 4x enlargement option when a small product image needs a larger display. A zoom comparison is particularly useful for labels, seams, and textures that shoppers will examine in the gallery.

Preparing illustrations for print

An approved illustration may be too small for the proposed poster layout. Enlarge it and show the returned pixel dimensions alongside a detail preview, helping the artist judge its suitability for the intended print size.

Refreshing archive images

Publishers often reuse older images in layouts with more space for photography. An enlargement queue can pair each processed result with its source, giving editors a focused way to inspect faces and fine detail before selecting an asset.

How to use AI Image Upscaler API

  1. Get an API key

    Create a key in the Developer Console and store it on your server. Use it in the Authorization: Bearer header.

  2. Prepare and submit your inputs

    Set up your inputs in the Playground, then copy the matching API request. Send it from your server with a unique Idempotency-Key.

  3. Track the task

    Save the returned taskId and query the same operation until it completes. Keep that identifier if your app stops waiting.

  4. Retrieve the result

    Read imageUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Send a numeric scale
The source field is imageURL and scale must be the integer 2 or 4. Read the completed asset from the differently cased imageUrl field.
Compare details at useful sizes
Check text, faces, and repeated patterns in the returned image. Enlargement is not a promise that missing source details have been faithfully recovered.

Input requirementsUpload local files

Task fields and results

Keep the task identifier with its original request and Idempotency-Key. Query the same capability until it completes, then read the documented result field.

Task identifier
taskId
Query route
POST /api/v1/image-upscaler/query
Completed result
imageUrl
Task states and response structure ↗
Errors, retries and limits

Retry transport failures with the same idempotency key only when the original submission may not have reached the server. For a confirmed task, keep querying the original task instead of submitting a duplicate.

Read error recovery guidance ↗

FAQs

Is an image upscaler the same as image-to-image editing?

Use image-to-image when you need to change the scene or subject with a prompt. This upscaler has no editing prompt.

Are failed or timed-out requests charged?

A client timeout is not a confirmed task failure. Confirmed failures are automatically refunded only when the refund outcome is certain. Unknown charges or refunds remain pending reconciliation.

Failure and refund handling ↗
How long should my app wait for a result?

The checked contract does not establish a fixed completion time. Choose a local wait budget for your app; it is not an API completion deadline.

Polling and wait budgets ↗
What are the rate and concurrency limits?

Request-rate limits control how often you can call the API; concurrency limits control simultaneous work. The documentation ties both to the stable API key but does not publish numeric limits for this operation. Confirm account limits before planning parallel jobs.

Rate-limit recovery ↗
Can I receive results through a webhook?

The checked request contract documents status queries and does not list a webhook or callback field for these routes. Check the current authenticated OpenAPI contract before making a callback part of your integration.

Query task results ↗Check the current contract ↗

Explore more APIs on VidMage

  • AI Image to Image API for Prompted Edits↗
  • AI Object Remover API for Masked Image Cleanup↗
  • GPT Image API↗
  • AI Image Watermark Remover API for Cleanup↗
  • AI Hairstyle Changer API for Photo Editing↗
  • AI Clothes Changer API for Outfit Previews↗
  • Midjourney Image API↗
  • AI Girl Generator API for Portrait Briefs↗