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 Face Swap API for Clip Workflows

AI Video Face Swap API for Clip Workflows

Integrate single-face replacement into your video workflow. Submit a clip and reference face image, select the tracked face to replace, and retrieve the completed video through an asynchronous task.

Get API keyView API docs
Abstract illustration for AI Video Face Swap API for Clip Workflows
PlaygroundAPIPricingGuideFAQs

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

4 parameters

Target-video fileUrl returned by upload_files.

Publicly reachable URL of the photo containing the replacement face.

Optional explicit zero-based tracked-face index. Omit to auto-select only one detected face.(Optional)

min 0

Optional explicit zero-based reference index. Omit to auto-select only one detected face.(Optional)

min 0

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-face-swap/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "targetVideoUrl": "https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4",
  "referenceFaceImageUrl": "https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp"
}')"
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-face-swap/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
targetVideoUrl referenceFaceImageUrl
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 Face Swap

RequiredtargetVideoUrl referenceFaceImageUrl
Request controls
  • targetFaceIndex: range 0 to ∞
  • referenceFaceIndex: range 0 to ∞

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 ↗

Video Face Swap

POST /api/v1/video-face-swap/submit

Full API documentation ↗

targetVideoUrl is required and referenceFaceImageUrl is required.

Required inputs

targetVideoUrlstring
Target-video fileUrl returned by upload_files.
referenceFaceImageUrlstring
Publicly reachable URL of the photo containing the replacement face.

Edit the sample inputs for your own task before submitting.

Video Face Swap 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-face-swap/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"targetVideoUrl":"https://vidmage.ai/assets/models/hailuo-ai-video-generator/skincare-ad.mp4","referenceFaceImageUrl":"https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp"}'
# -> { "success": true, "taskId": "...", "creditsRequired": ..., "creditsConsumed": 0, "usageDeferred": true }
Parameters and input rules4 fields
FieldTypeRequiredDefaultMeaning and limits
targetVideoUrlstringYesNot specifiedTarget-video fileUrl returned by upload_files. No additional field constraint listed.
referenceFaceImageUrlstringYesNot specifiedPublicly reachable URL of the photo containing the replacement face. No additional field constraint listed.
targetFaceIndexnumberNoNot specifiedOptional explicit zero-based tracked-face index. Omit to auto-select only one detected face. Minimum: 0 · Whole numbers only
referenceFaceIndexnumberNoNot specifiedOptional explicit zero-based reference index. Omit to auto-select only one detected face. Minimum: 0 · Whole numbers only

Retrieve the result

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

POST /api/v1/video-face-swap/query

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

Task states and recovery ↗
Video Face Swap query
curl -X POST "https://vidmage.ai/api/v1/video-face-swap/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 Face Swapvideo 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 Face Swap API

VidMage's AI Video Face Swap API is a video editing interface that replaces one tracked face in existing footage. It accepts a source video URL and a reference face image, then produces an edited video. Optional indices select the target person and the replacement face for each request. To swap a face in a clip without writing code, use VidMage's Video Face Swap.

AI Video Face Swap API capabilities

Edit an existing clip
Use targetVideoUrl for source footage and referenceFaceImageUrl for the replacement face in the resulting video.
Choose a tracked face
Select one tracked target face with targetFaceIndex when other people also appear in the footage.
Choose the replacement identity
Select a face from the reference photo with referenceFaceIndex before applying it to the video.

What you can build

Birthday video greetings

A reusable birthday clip becomes personal when the sender appears in it. Pair an editable greeting video with their portrait, and use the selected face replacement as the visual part of a message your app helps them compose.

Casting look previews

Before planning a screen test, a production team can explore an actor's appearance in existing test footage. Use the consenting actor's portrait as the face reference and compare the edited sequence with the original during the casting discussion.

Video souvenirs for event guests

Give a branded photo booth a video option. An approved campaign clip supplies the action, and a guest's booth portrait supplies the replacement face. Guests can watch their version before choosing to download or share it.

How to use AI Video Face Swap 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
Review the whole clip
Check turns, partial obstructions, cuts, and changes in face size. A useful preview frame does not show whether the result meets your needs throughout the video.
Keep the selection focused
One request replaces one tracked target face. Use nonnegative whole-number indices and verify the chosen person when others enter the scene. For multiple people, review the separate AI Multiple Face Swap Video capability.
Check API media limits
The reviewed API contract does not publish a complete duration, file-size and resolution limits table. Confirm current limits before uploading; consumer web limits do not establish API limits.
Upload local footage before submitting
Provide a reachable video URL or upload local bytes using the temporary upload instructions. Pass the returned fileUrl as targetVideoUrl, and keep the reference photo in its separate image field.

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-face-swap/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 ↗

Start with one short clip.

Review the inputs, then use your subscription to test in the live playground.

Build a request ↑

Explore more APIs on VidMage

  • AI Multi Face Swap API for Photos and Videos↗
  • AI Head Swap API for Photos and Videos↗
  • AI GIF Face Swap API for Animated Images↗
  • AI Photo Face Swap API↗
  • Wan Video API↗
  • SkyReels API↗
  • AI Video Watermark Remover API for Two Inputs↗
  • Seedance API↗