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

PixVerse API

Integrate text-to-video and image-to-video generation with PixVerse. Send a prompt or starting image, then configure clip length, resolution, and audio to fit the video workflow in your application.

Get API keyView API docs
Abstract illustration for PixVerse API
PlaygroundAPIPricingGuideFAQs

PixVerse 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 video to generate (max 2048 chars).

Optional input image URL. When provided, the task runs in image-to-video mode. In that mode, output ratio is inferred from the input image.(Optional)

Video duration in seconds.(Optional)

Default: 5

Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image.(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: 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/pixverse-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 tiny paper boat sails through a rain puddle while city lights shimmer in the reflections",
  "duration": "5",
  "aspectRatio": "16:9",
  "resolution": "720p",
  "sound": 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/pixverse-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.

PixVerse AI Video Generator

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

Additional inputs; requirements vary by mode

prompt imageUrl

Media limits by mode
  • Image To VideoImage: jpg, jpeg, png, webp
Request controls
  • duration: 15 accepted values; see parameter rules
  • aspectRatio: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9"
  • resolution: "360p", "540p", "720p", "1080p"
  • sound: 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 ↗

PixVerse AI Video Generator

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

Full API documentation ↗

prompt is required.

Required inputs

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

Edit the sample inputs for your own task before submitting.

PixVerse 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/pixverse-ai-video-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A tiny paper boat sails through a rain puddle while city lights shimmer in the reflections","duration":"5","aspectRatio":"16:9","resolution":"720p","sound":true}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules6 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the video to generate (max 2048 chars). Minimum length: 1 · Maximum length: 2048
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. In that mode, output ratio is inferred from the input image. No additional field constraint listed.
durationstringNo"5"Video duration in seconds. Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15" · Default: "5"
aspectRatiostringNo"16:9"Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image. Values: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9" · Default: "16:9"
resolutionstringNo"720p"Output resolution tier. Values: "360p", "540p", "720p", "1080p" · Default: "720p"
soundbooleanNotrueGenerate synchronized audio along with the video. No separate sound surcharge is configured. Default: true
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2048 characters
durationValues: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
aspectRatioValues: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9"; mode default: "16:9"
resolutionValues: "360p", "540p", "720p", "1080p"; mode default: "720p"
soundBoolean control; default true
Image To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2048 characters
durationValues: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
resolutionValues: "360p", "540p", "720p", "1080p"; mode default: "720p"
soundBoolean control; default true
imageUrlImage input

Retrieve the result

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

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

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

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

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
6–20 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 PixVerse API

VidMage's PixVerse API is a video generation interface that creates clips from text prompts or starting images. It supports requested durations of one to fifteen seconds, along with resolution and audio controls. Text mode includes aspect ratio settings, while image mode uses the source image to establish the composition. To explore this model's browser workflow, open VidMage's PixVerse AI Video Generator.

PixVerse API capabilities

Generate a new scene
Describe a subject, setting, and camera movement in a text prompt, then select a supported frame shape.
Animate a starting image
Provide imageUrl and a motion brief to request a video beginning from an existing visual.
Configure the output
Choose whole-second durations from one to fifteen, plus a listed resolution and an explicit sound setting.

What you can build

Opening hooks for social ads

A sneaker lands in a splash of paint. That single visual idea can become the opening of a portrait ad. Specify the action and clip length in the generation request; your ad editor handles the offer and CTA.

Motion in product catalog cards

Steam rising from a mug or a bag turning on a display can give a product catalog motion, using the item photo and a brief describing the action.

Illustrative travel cutaways

Fill a travel edit with a scene described by place, time of day, and camera movement. A quiet street at dawn might bridge two sections of the story. Choose supported framing to suit a vertical reel or a landscape edit.

How to use PixVerse 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
Choose the duration deliberately
Send duration as a string from "1" through "15". Keep very short requests focused on one simple movement instead of compressing several scene changes into them.
Frame the correct input mode
aspectRatio is a text-mode setting, not a separate image-mode control. When animating a source image, build your composition around that image and describe the motion.

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/pixverse-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

Can I use this route for transitions or video extension?

No. This route has no ending-frame or source-video input for transitions or extension. Choose a capability that explicitly documents the workflow you need.

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

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