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/Vidu API

Vidu API

Add Vidu video generation to your app from text or image references. Configure style and movement in text mode, or supply up to seven images with optional audio in the image workflow.

Get API keyView API docs
Abstract illustration for Vidu API
PlaygroundAPIPricingGuideFAQs

Vidu 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

9 parameters

Text prompt describing the video to generate (max 5000 chars).

Optional input image URL. When provided, the task runs in image-to-video mode.(Optional)

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

minItems 1maxItems 7

Video duration in seconds.(Optional)

Default: 5

Output aspect ratio.(Optional)

Default: 16:9

Output resolution tier.(Optional)

Default: 720p

Generate synchronized audio along with the video. No separate sound surcharge is configured.(Optional)

Default: false

Choose a general-purpose or anime-oriented visual style.(Optional)

Default: general

Control the overall amount of motion.(Optional)

Default: auto

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/vidu-ai-video-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A glass terrarium grows into a miniature rainforest as the camera slowly circles around it",
  "duration": "5",
  "aspectRatio": "16:9",
  "resolution": "720p",
  "sound": false,
  "style": "general",
  "movementAmplitude": "auto"
}')"
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/vidu-ai-video-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 // .["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
prompt
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.

Vidu AI Video Generator

Modes: text-to-video, image-to-video

Additional inputs; requirements vary by mode

prompt imageUrl imageUrls

Media limits by mode
  • Image To VideoImage: jpg, jpeg, png, webp; up to 50 MB per file; up to 7 files
Request controls
  • duration: 16 accepted values; see parameter rules
  • aspectRatio: "4:3", "3:4", "16:9", "9:16", "1:1", "auto"
  • resolution: "540p", "720p", "1080p"
  • sound: default false
  • style: "general", "anime"
  • movementAmplitude: "auto", "small", "medium", "large"

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

Vidu AI Video Generator

POST /api/v1/vidu-ai-video-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the video to generate (max 5000 chars).

Edit the sample inputs for your own task before submitting.

Vidu AI Video 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/vidu-ai-video-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A glass terrarium grows into a miniature rainforest as the camera slowly circles around it","duration":"5","aspectRatio":"16:9","resolution":"720p","style":"general","movementAmplitude":"auto"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules9 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the video to generate (max 5000 chars). Minimum length: 1 · Maximum length: 5000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. No additional field constraint listed.
imageUrlsstring[]NoNot specifiedOrdered input image URLs for reference-to-video mode. The prompt can reference them by their one-based order. Minimum items: 1 · Maximum items: 7
durationstringNo"5"Video duration in seconds. Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16" · Default: "5"
aspectRatiostringNo"16:9"Output aspect ratio. Values: "4:3", "3:4", "16:9", "9:16", "1:1", "auto" · Default: "16:9"
resolutionstringNo"720p"Output resolution tier. Values: "540p", "720p", "1080p" · Default: "720p"
soundbooleanNofalseGenerate synchronized audio along with the video. No separate sound surcharge is configured. Default: false
stylestringNo"general"Choose a general-purpose or anime-oriented visual style. Values: "general", "anime" · Default: "general"
movementAmplitudestringNo"auto"Control the overall amount of motion. Values: "auto", "small", "medium", "large" · Default: "auto"
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 4000 characters
durationValues: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"; mode default: "5"
aspectRatioValues: "4:3", "3:4", "16:9", "9:16", "1:1"; mode default: "16:9"
resolutionValues: "540p", "720p", "1080p"; mode default: "720p"
styleValues: "general", "anime"; Default: "general"
movementAmplitudeValues: "auto", "small", "medium", "large"; Default: "auto"
Image To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 5000 characters
durationValues: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16"; mode default: "5"
aspectRatioValues: "16:9", "9:16", "4:3", "3:4", "1:1", "auto"; mode default: "16:9"
resolutionValues: "540p", "720p", "1080p"; mode default: "720p"
soundBoolean control; default true
imageUrlsImage input; up to 7 items

Retrieve the result

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

POST /api/v1/vidu-ai-video-generator/query

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

Task states and recovery ↗
Vidu AI Video Generator query
curl -X POST "https://vidmage.ai/api/v1/vidu-ai-video-generator/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)
Vidu AI Video Generatorvideo API5-second video: 50 creditsresolution: 720p
How this is calculated
  • 540p: 6 credits / second
  • 720p: 10 credits / second
  • 1080p: 15 credits / second

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
6–15 credits / secondBase rate varies by settings or workflow
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 Vidu API

Build an animated short drama around text-led scene concepts or character and setting references. VidMage's Vidu API supports both approaches: text mode provides style and movement controls, while image mode accepts up to seven references and includes an audio setting. Each mode has its own duration range and output controls. Your episode editor connects the chosen clips and dialogue. To explore this model's browser workflow, open VidMage's Vidu AI Video Generator.

Vidu API capabilities

Describe a styled scene
Generate from text with general or anime style and a choice of movement amplitude settings.
Guide video with images
Supply up to seven image references and explain the subject, setting, and movement they should guide.
Configure image-mode audio
Set sound explicitly on an image-reference request, along with a supported duration and output resolution.

What you can build

Animated short drama scenes

Text mode offers an anime direction for a script beat; image mode gives you a way to guide a scene with character and setting references. Build an episode from selected clips in your editor, adding dialogue as the story takes shape.

Game character trailer concepts

Introduce a game character through an entrance, an attack pose, or a dramatic reveal. Character and environment images guide the scene request. Trailer teams can combine selected footage with gameplay and title cards to develop the pitch.

Animated storybook drafts

A friendly animal crosses a bridge to find a lost object. Such a small, readable action makes a useful scene brief for a storybook animation. Text-mode style and movement choices help illustrators explore its treatment before recording narration.

How to use Vidu 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
Use the mode's duration choices
Text requests list one to ten seconds; image-reference requests list three to sixteen. Send strings and validate against the chosen mode instead of the merged menu.
Set audio only where supported
Text mode does not accept sound. Image-reference mode does, with conflicting displayed defaults across the form and mode metadata, so specify your audio choice explicitly.

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/vidu-ai-video-generator/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

  • Seedance 2.5 API↗
  • Midjourney Video API↗
  • Veo 3.1 API↗
  • Seedance API↗
  • SkyReels API↗
  • Grok Video API↗
  • MiniMax H3 API↗
  • Kling API↗