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 Clothes Changer API for Outfit Previews

AI Clothes Changer API for Outfit Previews

Add outfit previews to your shopping or styling app. Submit a person photo and a garment image as separate inputs, then retrieve the edited image for your try-on interface.

Get API keyView API docs
Abstract illustration for AI Clothes Changer API for Outfit Previews
PlaygroundAPIPricingGuideFAQs

AI Clothes Changer 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 image.

URL of the clothing reference image.

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/clothes-changer/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "personImageUrl": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
  "clothImageUrl": "https://vidmage.ai/assets/images/samples/futuristic-red-suit.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/clothes-changer/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
personImageUrl clothImageUrl
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.

AI Clothes Changer

RequiredpersonImageUrl clothImageUrl

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 ↗

AI Clothes Changer

POST /api/v1/clothes-changer/submit

Full API documentation ↗

personImageUrl is required and clothImageUrl is required.

Required inputs

personImageUrlstring
URL of the person image.
clothImageUrlstring
URL of the clothing reference image.

Edit the sample inputs for your own task before submitting.

AI Clothes Changer 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/clothes-changer/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"personImageUrl":"https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp","clothImageUrl":"https://vidmage.ai/assets/images/samples/futuristic-red-suit.webp"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules2 fields
FieldTypeRequiredDefaultMeaning and limits
personImageUrlstringYesNot specifiedURL of the person image. No additional field constraint listed.
clothImageUrlstringYesNot specifiedURL of the clothing reference image. No additional field constraint listed.

Retrieve the result

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

POST /api/v1/clothes-changer/query

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

Task states and recovery ↗
AI Clothes Changer query
curl -X POST "https://vidmage.ai/api/v1/clothes-changer/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)
AI Clothes Changerimage API1 image request: 1 credit
How this is calculated
  • Per request: 1 credit / image

A fixed credit charge applies to this API request.

Estimate your own request ↗
1 credit / imageSee 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 Clothes Changer API

VidMage's AI Clothes Changer API is an image editing interface for creating visual outfit previews. It accepts a person photo and a garment image as separate inputs, then returns an edited image. This workflow supports clothing comparisons in shopping and styling applications. To explore an outfit change in your browser, open VidMage's AI Clothes Changer.

AI Clothes Changer API capabilities

Person and garment inputs
Pair one person photo with one garment image to request an outfit preview in your application.
Image-led clothing changes
Use the supplied garment image to guide the clothing edit without composing a separate text prompt.
Edited photo output
Retrieve the result as an image that your interface can show beside the person and garment references.

What you can build

Online outfit previews

A shopper's photo and a garment image from your catalog can become a visual try-on preview. Showing it beside the original garment helps shoppers explore the look, while sizing and fit advice remain separate parts of the shopping experience.

Stylist outfit shortlists

Bring a consultation shortlist onto the client's own photo. Submit each candidate garment separately, and group the edited images into a board that supports a discussion about the proposed looks and which pieces to try.

Personal wardrobe boards

Plan outfits around clothes a user already owns. Pair a garment photo with their portrait and save the preview to a wardrobe board for work, travel, or an event.

How to use AI Clothes Changer 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
Keep the input roles clear
Send the person photo as personImageUrl and the garment as clothImageUrl. Use separate upload labels so your interface does not accidentally swap these roles.
Present a visual preview
The result does not establish physical fit or clothing size. Keep measurements and size recommendations separate from the generated appearance in a shopping workflow.

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/clothes-changer/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

  • AI Image to Image API for Prompted Edits↗
  • AI Image Upscaler API for 2x and 4x Requests↗
  • GPT Image API↗
  • AI Object Remover API for Masked Image Cleanup↗
  • AI Image Watermark Remover API for Cleanup↗
  • AI Hairstyle Changer API for Photo Editing↗
  • Seedream API↗
  • AI Multi Face Swap API for Photos and Videos↗