# Face Swap API Documentation

> LLM-optimized documentation for Face Swap. Copy into your AI assistant for integration help.

## Overview

**Model ID:** `face-swap`
**Type:** Image Generation
**Credit Cost:** 0.25 credits per image

Swap a face, or the entire head including hair, from one photo into another while preserving pose, lighting, and background.

## Endpoint

```
POST https://pixeldojo.ai/api/v1/models/face-swap/run
```

## Authentication

All requests require an API key in the Authorization header:

```
Authorization: Bearer YOUR_API_KEY
```

Get your API key: https://pixeldojo.ai/api-platform/api-keys

## Input Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `image` | url | Yes | - | Target photo whose face will be replaced. Image URL or base64 data URI. |
| `face_image` | url | Yes | - | Source photo of the face to swap in. Also used as the head reference in head mode. |
| `swap_mode` | enum | No | face | 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. (Options: face, head) |
| `seed` | integer | No | - | Random seed for reproducibility (0 to 2147483647). Omit or 0 for a random seed. (min: 0, max: 2147483647) |



## Capabilities

- Image to Image

## Quick Start

### 1. Submit a Job

```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:**
```json
{
  "jobId": "job_abc123...",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123",
  "creditCost": 0.25,
  "creditsRemaining": 95
}
```

### 2. Poll for Results

```bash
curl "https://pixeldojo.ai/api/v1/jobs/job_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

**Completed Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "completed",
  "output": {
    "images": ["https://temp.pixeldojo.ai/..."]
  },
  "creditCost": 0.25
}
```

## Python Example

```python
import requests
import time

API_KEY = "YOUR_API_KEY"

# Submit job
response = requests.post(
    "https://pixeldojo.ai/api/v1/models/face-swap/run",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "image": "https://example.com/target-photo.jpg",
        "face_image": "https://example.com/new-face.jpg"
    }
)

job = response.json()
job_id = job["jobId"]

# Poll for completion
while True:
    status_response = requests.get(
        f"https://pixeldojo.ai/api/v1/jobs/{'{job_id}'}",
        headers={"Authorization": f"Bearer {API_KEY}"}
    )
    status = status_response.json()
    
    if status["status"] == "completed":
        print("Output:", status["output"])
        break
    elif status["status"] == "failed":
        print("Error:", status.get("error"))
        break
    
    time.sleep(2)
```

## JavaScript Example

```javascript
const API_KEY = 'YOUR_API_KEY';

// Submit job
const submitResponse = await fetch('https://pixeldojo.ai/api/v1/models/face-swap/run', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "image": "https://example.com/target-photo.jpg",
    "face_image": "https://example.com/new-face.jpg"
  })
});

const job = await submitResponse.json();

// Poll for completion
const pollForResult = async (jobId) => {
  while (true) {
    const statusResponse = await fetch(`https://pixeldojo.ai/api/v1/jobs/${jobId}`, {
      headers: { 'Authorization': `Bearer ${API_KEY}` }
    });
    const status = await statusResponse.json();
    
    if (status.status === 'completed') return status.output;
    if (status.status === 'failed') throw new Error(status.error);
    
    await new Promise(r => setTimeout(r, 2000));
  }
};

const output = await pollForResult(job.jobId);
console.log('Output:', output);
```

## 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.

## Error Codes

| Code | Status | Description |
|------|--------|-------------|
| `unauthorized` | 401 | Invalid or missing API key |
| `insufficient_credits` | 402 | Not enough credits |
| `invalid_request` | 400 | Invalid parameters |
| `model_not_found` | 404 | Model ID not found |
| `internal_error` | 500 | Server error |

## Links

- **Full Documentation:** https://pixeldojo.ai/api-platform/face-swap
- **API Keys:** https://pixeldojo.ai/api-platform/api-keys
- **Buy Credits:** https://pixeldojo.ai/api-platform/buy-credits
- **All Models:** https://pixeldojo.ai/api/v1/models
- **OpenAPI Spec:** https://pixeldojo.ai/api/openapi