Photo Head Swap API documentation
Replace one or more complete heads in a target photo while preserving the target composition, body, background, text, head pose, gaze, and expression. Reference images control identity, hairstyle, and skin tone; an optional prompt selects and maps people in group photos.
Endpoints
| Contract item | Value |
|---|---|
| Capability | head-swap |
| Submit | POST https://vidmage.ai/api/v1/head-swap/submit |
| Query | POST https://vidmage.ai/api/v1/head-swap/query |
| Task identifier | taskId |
| Result field | imageUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: AI Head Swap API for Photos and Videos
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
targetImageUrl | string | Yes | Not specified | Publicly reachable URL of the target photo. |
referenceImageUrls | string[] | Yes | Not specified | One to 4 publicly reachable head-reference image URLs, ordered to match the requested people. Minimum items: 1Maximum items: 4 |
customPrompt | string | No | Not specified | Optional targeting instructions that identify which person or people to replace and map them to Reference 1 through Reference 4. Maximum characters: 1000 |
aspectRatio | string | No | "1:1" | Output aspect ratio. Values: "3:2", "2:3", "16:9", "9:16", "4:3", "3:4", "1:1" |
Example request
{
"targetImageUrl": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
"referenceImageUrls": [
"https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp"
],
"aspectRatio": "1:1"
}# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/head-swap/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"targetImageUrl":"https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp","referenceImageUrls":["https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp"],"aspectRatio":"1:1"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Task results and recovery
URL of the completed head-swapped image. Read imageUrl from the completed query response. Preserve taskId while the task is running.
curl -X POST "https://vidmage.ai/api/v1/head-swap/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| Per request | 5 credits / image | — |
A fixed credit charge applies to this API request.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.