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/Wan Image API

Wan Image API

Integrate Wan image generation and editing into your app with explicit width and height controls. Generate from text or submit up to nine source images with instructions for the changes you need.

Get API keyView API docs
Abstract illustration for Wan Image API
PlaygroundAPIPricingGuideFAQs

Wan Image 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

6 parameters

Text prompt describing the image to generate (max 5000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names.

Optional input image URL. When provided, the task runs in image edit mode.(Optional)

Ordered input image URLs for image editing mode. The prompt can reference them by their one-based order.(Optional)

minItems 1maxItems 9

Output width in pixels.(Optional)

Default: 1024min 512max 4096

Output height in pixels.(Optional)

Default: 1024min 512max 4096

Enable enhanced reasoning for better prompt understanding and image quality.(Optional)

Default: true

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/wan-image-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A whimsical floating library above a sea of clouds, intricate fantasy environment concept art",
  "width": 1024,
  "height": 1024,
  "thinkingMode": true
}')"
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/wan-image-generator/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
prompt
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.

Wan Image Generator

Modes: text-to-image, image-edit

Additional inputs; requirements vary by mode

prompt imageUrl imageUrls

Media limits by mode
  • Image EditImage: jpg, jpeg, png, webp; up to 9 files
Request controls
  • width: default 1024
  • height: default 1024
  • thinkingMode: default true

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

Wan Image Generator

POST /api/v1/wan-image-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the image to generate (max 5000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names.

Edit the sample inputs for your own task before submitting.

Wan Image Generator 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/wan-image-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A whimsical floating library above a sea of clouds, intricate fantasy environment concept art","width":1024,"height":1024,"thinkingMode":true}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules6 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the image to generate (max 5000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names. Minimum length: 1 · Maximum length: 5000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image edit mode. No additional field constraint listed.
imageUrlsstring[]NoNot specifiedOrdered input image URLs for image editing mode. The prompt can reference them by their one-based order. Minimum items: 1 · Maximum items: 9
widthnumberNo1024Output width in pixels. Default: 1024 · Minimum: 512 · Maximum: 4096 · Multiple of: 1 · Whole numbers only
heightnumberNo1024Output height in pixels. Default: 1024 · Minimum: 512 · Maximum: 4096 · Multiple of: 1 · Whole numbers only
thinkingModebooleanNotrueEnable enhanced reasoning for better prompt understanding and image quality. Default: true
Mode-specific fields & media limits
Text To Image rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 5000 characters
widthRange: 512 to 4096; Default: 1024
heightRange: 512 to 4096; Default: 1024
thinkingModeDefault: true
Image Edit rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2048 characters
imageUrlsImage input; up to 9 items
widthRange: 512 to 4096; Default: 1024
heightRange: 512 to 4096; Default: 1024

Retrieve the result

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

POST /api/v1/wan-image-generator/query

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

Task states and recovery ↗
Wan Image Generator query
curl -X POST "https://vidmage.ai/api/v1/wan-image-generator/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)
Wan Image Generatorimage API1 image request: 5 credits
How this is calculated
  • Base rate: 5 credits / generation

Base charge is per generation at the selected resolution.

Estimate your own request ↗
5 credits / generationSee 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 Wan Image API

VidMage's Wan Image API is an interface for generating images from text and editing compositions with source references. Numeric width and height define the canvas, and editing accepts up to nine images. Text generation includes a thinking-mode switch, while editing has its own prompt limit and available controls. To explore this model's browser workflow, open VidMage's Wan Image Generator.

Wan Image API capabilities

Create a sized composition
Describe a new image and set numeric width and height around the layout you need.
Edit from reference images
Supply up to nine images and explain the subject, setting, or change each source should guide.
Configure text-mode thinking
Set thinkingMode explicitly when generating from text, keeping the written brief and canvas stable for comparison.

What you can build

Website hero compositions

A page headline needs somewhere to sit. Describe the subject on one side of an accepted canvas and leave room for copy on the other. Preview the generated image inside the actual layout to judge the balance.

Furniture listing scenes

Show how a chair might look within a styled room using the product photo and interior references. Placement and lighting go in the edit brief. The retailer can compare the resulting scene with the source to check the chair's shape and finish.

Course illustrations

A workplace scenario can explain the context of a lesson before the text gets into detail. Turn a scene brief into an image sized for the lesson slide, with accurate labels and teaching points added separately in the course editor.

How to use Wan Image 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
Use dimensions instead of a ratio
This capability uses width and height, not an aspectRatio menu. Check the accepted dimension combination before exposing a custom canvas field in your application.
Keep text and edit controls separate
Text mode permits a 5,000 character prompt and lists thinkingMode as a boolean, not a quality scale. Editing permits 2,048 characters and up to nine source images, without that thinking switch.

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/wan-image-generator/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

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

  • Wan Video API↗
  • Grok Image API↗
  • Z-Image API↗
  • Seedream API↗
  • Nano Banana API↗
  • Qwen Image API↗
  • Midjourney Image API↗
  • GPT Image API↗