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 Hairstyle Changer API for Photo Editing

AI Hairstyle Changer API for Photo Editing

Build hairstyle previews into your app with a portrait URL and a hairstyle prompt. Describe the requested cut, color, or styling change, then retrieve the edited image for comparison.

Get API keyView API docs
Abstract illustration for AI Hairstyle Changer API for Photo Editing
PlaygroundAPIPricingGuideFAQs

AI Hairstyle 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 source portrait image.

Text description of the desired hairstyle.

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/ai-hairstyle-changer/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",
  "hairstylePrompt": "Replace the current hairstyle with shoulder-length soft waves and natural curtain bangs"
}')"
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/ai-hairstyle-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
imageUrl hairstylePrompt
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 Hairstyle Changer

RequiredimageUrl hairstylePrompt
Request controls
  • hairstylePrompt: see parameter rules

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 Hairstyle Changer

POST /api/v1/ai-hairstyle-changer/submit

Full API documentation ↗

imageUrl is required and hairstylePrompt is required.

Required inputs

imageUrlstring
URL of the source portrait image.
hairstylePromptstring
Text description of the desired hairstyle.

Edit the sample inputs for your own task before submitting.

AI Hairstyle 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/ai-hairstyle-changer/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","hairstylePrompt":"Replace the current hairstyle with shoulder-length soft waves and natural curtain bangs"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules2 fields
FieldTypeRequiredDefaultMeaning and limits
imageUrlstringYesNot specifiedURL of the source portrait image. No additional field constraint listed.
hairstylePromptstringYesNot specifiedText description of the desired hairstyle. No additional field constraint listed.

Retrieve the result

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

POST /api/v1/ai-hairstyle-changer/query

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

Task states and recovery ↗
AI Hairstyle Changer query
curl -X POST "https://vidmage.ai/api/v1/ai-hairstyle-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 Hairstyle Changerimage API1 image request: 5 credits
How this is calculated
  • Per request: 5 credits / image

A fixed credit charge applies to this API request.

Estimate your own request ↗
5 credits / 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 Hairstyle Changer API

VidMage's AI Hairstyle Changer API is a portrait editing interface for previewing hairstyle changes. It accepts a person photo and a text description of the requested cut, color, or styling change. The result is an edited image that can be compared with the original portrait. To preview a hairstyle on a photo in your browser, use VidMage's AI Hairstyle Changer.

AI Hairstyle Changer API capabilities

Portrait-based hairstyle edits
Use a single portrait image as the starting point for a requested change to the person's hairstyle.
Written hairstyle briefs
Describe the intended cut, color, or styling in hairstylePrompt instead of choosing an API preset identifier.
Image comparison output
Retrieve the edited image and pair it with the source portrait in your application's comparison view.

What you can build

Salon consultations

Make a haircut discussion easier to visualize. A client's portrait and a description such as a chin-length bob with side bangs produce an edited image that the client and stylist can discuss alongside the original.

Hair color comparisons

Compare copper, dark brown, or subtle highlights on the same portrait through separate requests. The resulting color board gives a salon consultation specific ideas to discuss.

Wedding hairstyle planning

Planning a wedding look often means narrowing down several styles before a trial appointment. Pair the bride's portrait with descriptions of a low bun, loose waves, or another option, and save the previews with the briefs for her stylist.

How to use AI Hairstyle 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
Prepare a useful portrait
Choose a photo where the hair and head shape are easy to inspect. Keep the original beside each output to evaluate the requested style change.
Turn choices into clear text
The request accepts imageUrl and hairstylePrompt, with no preset ID or hairstyle-reference image. Your interface can translate its own style choices into a readable description.

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/ai-hairstyle-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

Does the contract guarantee that the face stays unchanged?

The published contract gives no exact face-preservation guarantee. Check the face in each output before approving the edit.

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 Watermark Remover API for Cleanup↗
  • AI Object Remover API for Masked Image Cleanup↗
  • AI Image Upscaler API for 2x and 4x Requests↗
  • AI Clothes Changer API for Outfit Previews↗
  • GPT Image API↗
  • Nano Banana API↗
  • Z-Image API↗