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 Video Upscaler API for 2x and 4x Requests

AI Video Upscaler API for 2x and 4x Requests

Add video upscaling to your media processing pipeline. Submit a source video URL, set a 2x or 4x scale, and retrieve the enlarged clip for your application.

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

AI Video 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

Source-video fileUrl returned by upload_files.

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/video-upscaler/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "videoURL": "https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4",
  "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/video-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 // .["videoUrl"] // .data["videoUrl"] // 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
videoURL scale
Output
Video·videoUrl
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.

Video Upscaler

RequiredvideoURL 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 ↗

Video Upscaler

POST /api/v1/video-upscaler/submit

Full API documentation ↗

videoURL is required and scale is required.

Required inputs

videoURLstring
Source-video fileUrl returned by upload_files.
scalenumber
Upscale factor.

Edit the sample inputs for your own task before submitting.

Video 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/video-upscaler/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"videoURL":"https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4","scale":2}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules2 fields
FieldTypeRequiredDefaultMeaning and limits
videoURLstringYesNot specifiedSource-video fileUrl returned by upload_files. 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/video-upscaler/query

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

Task states and recovery ↗
Video Upscaler query
curl -X POST "https://vidmage.ai/api/v1/video-upscaler/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "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)
Video Upscalervideo API5.875-second video: 6 credits
How this is calculated
  • Video duration: 1 credit / second

The example uses the duration shown above. The server measures uploaded media for billing; this duration is only supplied to the estimate.

Duration × rate is rounded up to whole credits; the applicable minimum charge is enforced.

Estimate your own request ↗
1 credit / secondSee 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 Video Upscaler API

VidMage's AI Video Upscaler API is a video processing interface for enlarging clips by a requested factor of 2x or 4x. It accepts a source video and a numeric scale setting, then returns a processed video. The result can be compared with the source to review detail and motion. To upscale a clip in your browser, use VidMage's AI Video Upscaler.

AI Video Upscaler API capabilities

2x video enlargement
Request a scale of 2 for a source clip that needs the smaller supported enlargement factor.
4x video enlargement
Request a scale of 4 when your workflow needs the larger supported video enlargement option.
Processed clip output
Retrieve the enlarged video and inspect its actual dimensions, visual detail, and movement in a review player.

What you can build

Preparing generated scenes for delivery

When a selected scene needs a larger display size, a 2x or 4x enlargement gives the editor another version to consider. Inspect its actual dimensions, faces, and moving edges against the project's delivery requirements.

Refreshing archive interviews

Older interview footage may need to sit alongside newer material in a documentary. Enlarge the source and compare matching moments in paired players, focusing on facial detail and motion as the editor decides how to use the clip.

Larger product demo players

A small demonstration video can look different when it fills a larger gallery player. Process an enlarged version and check labels, textures, and hand movement at the intended display size before choosing the gallery asset.

How to use AI Video 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 videoUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Preserve the input casing
Use videoURL for the source and an integer scale of 2 or 4. The result uses videoUrl, with different casing from the input.
Inspect actual delivery properties
The request has no codec, bitrate, frame-rate, interpolation, or custom dimension controls. Do not infer frame interpolation from upscaling. Check the returned media before labeling an export or adding a later conversion step.

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/video-upscaler/query
Completed result
videoUrl
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

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 Video to Video API for Style Transformations↗
  • AI Video Watermark Remover API for Two Inputs↗
  • AI Subtitle Generator API for Video Captions↗
  • AI Video Extender API for Clip Continuations↗
  • AI Video Background Remover API for Clips↗
  • Runway API↗
  • Seedance 2.5 API↗
  • AI Head Swap API for Photos and Videos↗