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 Photo Dance API for Reference-Led Animation

AI Photo Dance API for Reference-Led Animation

Build photo dance features into your app using a subject image and a dance reference video. Submit both asset URLs and retrieve the generated video for playback in your interface.

Get API keyView API docs
Abstract illustration for AI Photo Dance API for Reference-Led Animation
PlaygroundAPIPricingGuideFAQs

AI Photo Dance 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 person photo.

Reference-video fileUrl returned by upload_files; maximum 30 seconds.

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/photo-dance/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",
  "videoUrl": "https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4"
}')"
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/photo-dance/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
imageUrl videoUrl
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.

Photo Dance

RequiredimageUrl videoUrl

Output dimensions and format are not specified in this reference.

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

Photo Dance

POST /api/v1/photo-dance/submit

Full API documentation ↗

imageUrl is required and videoUrl is required.

Required inputs

imageUrlstring
URL of the person photo.
videoUrlstring
Reference-video fileUrl returned by upload_files; maximum 30 seconds.

Edit the sample inputs for your own task before submitting.

Photo Dance 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/photo-dance/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","videoUrl":"https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules2 fields
FieldTypeRequiredDefaultMeaning and limits
imageUrlstringYesNot specifiedURL of the person photo. No additional field constraint listed.
videoUrlstringYesNot specifiedReference-video fileUrl returned by upload_files; maximum 30 seconds. No additional field constraint listed.

Retrieve the result

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

POST /api/v1/photo-dance/query

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

Task states and recovery ↗
Photo Dance query
curl -X POST "https://vidmage.ai/api/v1/photo-dance/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)
Photo Dancevideo API5.875-second video: 59 credits
How this is calculated
  • Video duration: 10 credits / second · 20 credits minimum

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 ↗
10 credits / second20 credits minimum
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 Photo Dance API

VidMage's AI Photo Dance API is an animation interface that creates dance videos from a subject photo and a choreography reference. The photo provides the subject, while the reference video guides the dance. The output is a generated video for preview or further use in a dance creation workflow. To explore a dance animation in your browser, open VidMage's Photo Dance.

AI Photo Dance API capabilities

Photo-based subject input
Use a subject image as the visual starting point for a dance animation in your application.
Choreography reference input
Provide a video of the desired dance as the movement reference paired with the subject photo.
Generated dance video
Retrieve the resulting video and show it beside the subject image and chosen dance reference for review.

What you can build

Dance greeting videos

Pair the sender's own photo with a dance reference for a celebration video, and use your greeting editor to add a personal message around the generated performance.

Dance libraries for virtual characters

Give a character creator a routine picker backed by reference videos. A selected dance and the character image form each request, producing performances that can be organized into a social content plan for that character.

Choreography concept boards

Animation teams can try the same character artwork against different rehearsal videos. Comparing each generated dance with its reference helps the team discuss a movement direction for a music video or animated performance.

How to use AI Photo Dance 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
Keep the two media roles visible
Send the subject as imageUrl and the dance reference as videoUrl. A local dance library should resolve its choices to actual reference video URLs.
Review movement and sound separately
Inspect the generated dance throughout the sequence. The contract has no separate audio input and does not establish whether the reference soundtrack will be preserved or synchronized to the movement.

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/photo-dance/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

When should I choose AI Photo Dance instead of AI Motion Control?

Use Photo Dance for choreography selection and dance review. Motion Control covers broader gestures or performances; the published contracts establish no model, quality, or beat-sync advantage for either.

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 Lip Sync API for Photos and Videos↗
  • AI Motion Control API for Character Animation↗
  • AI Video to Video API for Style Transformations↗
  • AI Video Extender API for Clip Continuations↗
  • Kling API↗
  • Sora 2 API↗
  • AI Video Face Swap API for Clip Workflows↗
  • Midjourney Video API↗