Image Generation

Face Swap API

Swap a face, or the entire head including hair, from one photo into another while preserving pose, lighting, and background. Integrate this model via REST with endpoint docs, parameters, and code examples.

Compare image models Use cases

Img2Img

Credit Cost

0.25 credits

Type

Image

Get API Key

Create auth keys for apps and agents

See Usage

Track requests, credits, and logs

Buy Credits

Top up prepaid API capacity

API Endpoint

POST

/api/v1/models/face-swap/run

Test This Model

Run a real request through the API pipeline and inspect the exact input and output your integration will handle. Uses your credits like any API call; failed runs are refunded automatically.

LLM.txt

AI-Ready

For AI assistants

Copy this model's documentation into Claude, GPT, or any AI for instant integration help.

/llm/face-swap.txt

OpenAPI Spec

Swagger compatible

Import into Postman, Swagger UI, or generate client SDKs in any language.

/api/openapi

Parameters

Input parameters accepted by this model

Parameter	Type	Description	Default
`image` required	url	Target photo whose face will be replaced. Image URL or base64 data URI.	-
`face_image` required	url	Source photo of the face to swap in. Also used as the head reference in head mode.	-
`swap_mode`	enum	Choose 'face' to replace just the facial region, keeping the target's hair. Choose 'head' to transfer the full head: face, hair, contour, and ears. `facehead`	`face`
`seed`	integer	Random seed for reproducibility (0 to 2147483647). Omit or 0 for a random seed. min: 0 \| max: 2147483647	-

Use saved characters (@Name)

This model takes no reference images, so @Name of a saved character is refused (400) before anything is charged. A saved location, prop or style with a description is inserted as text. For saved characters, use a model that takes reference images, such as Nano Banana Pro or Seedream 5 for images, or Seedance 2.5 or WAN 3.0 for video.

Code Examples

Swap a face: copy and paste to get started

bash

curl -X POST "https://pixeldojo.ai/api/v1/models/face-swap/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "https://example.com/target-photo.jpg",
    "face_image": "https://example.com/new-face.jpg"
  }'

Response Format

Submit Response (202 Accepted)

json

{
  "jobId": "job_abc123...",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123...",
  "creditCost": 0.25,
  "creditsRemaining": 95,
  "expiresAt": "2026-11-16T17:22:20Z"
}

Completed Response

json

{
  "jobId": "job_abc123...",
  "status": "completed",
  "output": {
    "images": [
      "https://temp.pixeldojo.ai/pixeldojotemp/1705930123-456789.png"
    ]
  },
  "creditCost": 0.25,
  "expiresAt": "2026-11-16T17:22:20Z"
}

LLM Documentation Try in Web UI Get API Key Usage Dashboard Buy Credits