atlascloud/face-swap-image

image-tools

Face Swap API by Atlas Cloud

atlascloud/face-swap-image

Face-swap-image

Swap a face onto any photo. The facial identity is transferred while pose, clothing and background stay intact.

INPUT

Source Face *

You can drag and drop a file or click to upload

MAX:1

Target Image *

You can drag and drop a file or click to upload

MAX:1

Size

Output Format

OUTPUT

Idle

Your generated images will appear here

Configure your settings and click Run to get started

Your request will cost $0.09 per run. For $10 you can run this model approximately 111 times.

Here's what you can do next:

Image-to-Video Image-to-Image

Parameters

Code Example
import requests
import time

# Step 1: Start image generation
generate_url = "https://api.atlascloud.ai/api/v1/model/generateImage"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer $ATLASCLOUD_API_KEY"
}
data = {
    "model": "atlascloud/face-swap-image",  # Required. Model name
    "image": "example_value",  # Required. ① 源脸 (Source Face) — 要换上去的那张脸，清晰正面照最佳
    "Image": "example_value",  # Required. ② 目标图 (Target Image) — 被换脸的照片，默认替换完整头部，保留身体、服装、姿势和背景
    "output_format": "jpeg",  # Output image format. options: jpeg | png
    "size": "auto",  # Output image resolution/size
}

generate_response = requests.post(generate_url, headers=headers, json=data)
generate_result = generate_response.json()
prediction_id = generate_result["data"]["id"]

# Step 2: Poll for result
poll_url = f"https://api.atlascloud.ai/api/v1/model/prediction/{prediction_id}"

def check_status():
    while True:
        response = requests.get(poll_url, headers={"Authorization": "Bearer $ATLASCLOUD_API_KEY"})
        result = response.json()

        if result["data"]["status"] == "completed":
            print("Generated image:", result["data"]["outputs"][0])
            return result["data"]["outputs"][0]
        elif result["data"]["status"] == "failed":
            raise Exception(result["data"]["error"] or "Generation failed")
        else:
            # Still processing, wait 2 seconds
            time.sleep(2)

image_url = check_status()

Install

Install the required package for your language.

pip install requests

Authentication

All API requests require authentication via an API key. You can get your API key from the Atlas Cloud dashboard.

export ATLASCLOUD_API_KEY="your-api-key-here"

HTTP Headers

import os

API_KEY = os.environ.get("ATLASCLOUD_API_KEY")
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {API_KEY}"
}

Keep your API key secure

Never expose your API key in client-side code or public repositories. Use environment variables or a backend proxy instead.

Submit a request

import requests

url = "https://api.atlascloud.ai/api/v1/model/generateImage"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer $ATLASCLOUD_API_KEY"
}
data = {
    "model": "your-model",
    "prompt": "A beautiful landscape"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

Submit a Request

Submit an asynchronous generation request. The API returns a prediction ID that you can use to check the status and retrieve the result.

POST/api/v1/model/generateImage

Request Body

import requests

url = "https://api.atlascloud.ai/api/v1/model/generateImage"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer $ATLASCLOUD_API_KEY"
}

data = {
    "model": "atlascloud/face-swap-image",
    "prompt": "A beautiful landscape with mountains and lake"
}

response = requests.post(url, headers=headers, json=data)
result = response.json()

print(f"Prediction ID: {result['data']['id']}")
print(f"Status: {result['data']['status']}")

Response

{
  "code": 200,
  "data": {
    "id": "pred_abc123",
    "status": "processing",
    "model": "model-name",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

Check Status

Poll the prediction endpoint to check the current status of your request.

GET/api/v1/model/prediction/{prediction_id}

Polling Example

import requests
import time

prediction_id = "pred_abc123"
url = f"https://api.atlascloud.ai/api/v1/model/prediction/{prediction_id}"
headers = { "Authorization": "Bearer $ATLASCLOUD_API_KEY" }

while True:
    response = requests.get(url, headers=headers)
    result = response.json()
    status = result["data"]["status"]
    print(f"Status: {status}")

    if status in ["completed", "succeeded"]:
        output_url = result["data"]["outputs"][0]
        print(f"Output URL: {output_url}")
        break
    elif status == "failed":
        print(f"Error: {result['data'].get('error', 'Unknown')}")
        break

    time.sleep(3)

Status Values

processingThe request is still being processed.

completedGeneration is complete. Outputs are available.

succeededGeneration succeeded. Outputs are available.

failedGeneration failed. Check the error field.

Completed Response

{
  "data": {
    "id": "pred_abc123",
    "status": "completed",
    "outputs": [
      "https://storage.atlascloud.ai/outputs/result.png"
    ],
    "metrics": {
      "predict_time": 8.3
    },
    "created_at": "2025-01-01T00:00:00Z",
    "completed_at": "2025-01-01T00:00:10Z"
  }
}

Upload Files

Upload files to Atlas Cloud storage and get a URL you can use in your API requests. Use multipart/form-data to upload.

POST/api/v1/model/uploadMedia

Upload Example

import requests

url = "https://api.atlascloud.ai/api/v1/model/uploadMedia"
headers = { "Authorization": "Bearer $ATLASCLOUD_API_KEY" }

with open("image.png", "rb") as f:
    files = {"file": ("image.png", f, "image/png")}
    response = requests.post(url, headers=headers, files=files)

result = response.json()
download_url = result["data"]["download_url"]
print(f"File URL: {download_url}")

Response

{
  "data": {
    "download_url": "https://storage.atlascloud.ai/uploads/abc123/image.png",
    "file_name": "image.png",
    "content_type": "image/png",
    "size": 1024000
  }
}

Input Schema

The following parameters are accepted in the request body.

Total: 5Required: 3Optional: 2

modelstringrequired

Model name.

Default: "atlascloud/face-swap-image"

imagestringrequired

① 源脸 (Source Face) — 要换上去的那张脸，清晰正面照最佳。

Imagestringrequired

② 目标图 (Target Image) — 被换脸的照片，默认替换完整头部，保留身体、服装、姿势和背景。

output_formatstring

Output image format. Seedream v5.0 Pro supports jpeg and png.

Default: "jpeg"

jpegpng

sizestring

Output image resolution/size. Use auto to detect the target image aspect ratio and choose the closest Seedream-supported size; explicit values are passed through when supported by the model.

Default: "auto"

auto2048*20482304*17281728*23042720*15301530*27202496*16641664*24961024*10241536*15361776*13281328*17762048*11521152*2048

Example Request Body

{
  "model": "atlascloud/face-swap-image",
  "image": "example_image",
  "Image": "example_Image",
  "output_format": "jpeg",
  "size": "auto"
}

Output Schema

The API returns a prediction response with the generated output URLs.

created_atstring

ISO timestamp of when the request was created.

idstring

Unique identifier for the prediction.

modelstring

Model ID used for the prediction.

outputsarray

Array of URLs to the generated content. Empty when status is not completed.

statusstring

Status of the task: created, processing, completed, or failed.

Example Response

{
  "id": "pred_abc123",
  "status": "completed",
  "model": "model-name",
  "outputs": [
    "https://storage.atlascloud.ai/outputs/result.png"
  ],
  "metrics": {
    "predict_time": 8.3
  },
  "created_at": "2025-01-01T00:00:00Z",
  "completed_at": "2025-01-01T00:00:10Z"
}

Atlas Cloud Skills

Atlas Cloud Skills integrates 400+ AI models directly into your AI coding assistant. One command to install, then use natural language to generate images, videos, and chat with LLMs.

Supported Clients

Claude Code

OpenAI Codex

Gemini CLI

Cursor

Windsurf

VS Code

Trae

GitHub Copilot

Cline

Roo Code

Amp

Goose

Replit

40+ supported clients

Install

npx skills add AtlasCloudAI/atlas-cloud-skills

Setup API Key

Get your API key from the Atlas Cloud dashboard and set it as an environment variable.

export ATLASCLOUD_API_KEY="your-api-key-here"

Capabilities

Once installed, you can use natural language in your AI assistant to access all Atlas Cloud models.

Image GenerationGenerate images with models like Nano Banana 2, Z-Image, and more.

Video CreationCreate videos from text or images with Kling, Vidu, Veo, etc.

LLM ChatChat with Qwen, DeepSeek, and other large language models.

Media UploadUpload local files for image editing and image-to-video workflows.

Learn more

github.com/AtlasCloudAI/atlas-cloud-skills

MCP Server

Atlas Cloud MCP Server connects your IDE with 400+ AI models via the Model Context Protocol. Works with any MCP-compatible client.

Supported Clients

Cursor

VS Code

Windsurf

Claude Code

OpenAI Codex

Gemini CLI

Cline

Roo Code

100+ supported clients

Install

npx -y atlascloud-mcp

Configuration

Add the following configuration to your IDE's MCP settings file.

{
  "mcpServers": {
    "atlascloud": {
      "command": "npx",
      "args": [
        "-y",
        "atlascloud-mcp"
      ],
      "env": {
        "ATLASCLOUD_API_KEY": "your-api-key-here"
      }
    }
  }
}

Available Tools

atlas_generate_imageGenerate images from text prompts.

atlas_generate_videoCreate videos from text or images.

atlas_chatChat with large language models.

atlas_list_modelsBrowse 400+ available AI models.

atlas_quick_generateOne-step content creation with auto model selection.

atlas_upload_mediaUpload local files for API workflows.

Learn more

github.com/AtlasCloudAI/mcp-server

API Schema

{
  "info": {
    "title": "AtlasCloud API",
    "version": "1.0.0",
    "description": "AtlasCloud Face Swap (image) tool."
  },
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/model/generateImage": {
      "post": {
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Input"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PredictionResponse"
                }
              }
            },
            "description": "The request status."
          }
        },
        "x-api-name": "model_run"
      }
    },
    "/api/v1/model/prediction/{request_id}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "request_id",
            "required": true,
            "schema": {
              "description": "Request ID",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PredictionResponse"
                }
              }
            },
            "description": "Result of the request."
          }
        },
        "x-api-name": "model_result"
      }
    }
  },
  "components": {
    "schemas": {
      "Input": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "description": "Model name.",
            "default": "atlascloud/face-swap-image"
          },
          "image": {
            "type": "string",
            "description": "① 源脸 (Source Face) — 要换上去的那张脸，清晰正面照最佳。",
            "x-format": "image",
            "x-label": "Source Face"
          },
          "Image": {
            "type": "string",
            "description": "② 目标图 (Target Image) — 被换脸的照片，默认替换完整头部，保留身体、服装、姿势和背景。",
            "x-format": "image",
            "x-label": "Target Image"
          },
          "output_format": {
            "type": "string",
            "description": "Output image format. Seedream v5.0 Pro supports jpeg and png.",
            "default": "jpeg",
            "enum": [
              "jpeg",
              "png"
            ],
            "x-label": "Output Format",
            "x-ui-component": "select"
          },
          "size": {
            "type": "string",
            "description": "Output image resolution/size. Use auto to detect the target image aspect ratio and choose the closest Seedream-supported size; explicit values are passed through when supported by the model.",
            "default": "auto",
            "enum": [
              "auto",
              "2048*2048",
              "2304*1728",
              "1728*2304",
              "2720*1530",
              "1530*2720",
              "2496*1664",
              "1664*2496",
              "1024*1024",
              "1536*1536",
              "1776*1328",
              "1328*1776",
              "2048*1152",
              "1152*2048"
            ],
            "x-ui-component": "select",
            "x-label": "Output Resolution"
          }
        },
        "required": [
          "model",
          "image",
          "Image"
        ],
        "x-order-properties": [
          "model",
          "image",
          "Image",
          "size",
          "output_format"
        ]
      },
      "PredictionResponse": {
        "type": "object",
        "properties": {
          "created_at": {
            "description": "ISO timestamp of when the request was created.",
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the prediction.",
            "type": "string"
          },
          "model": {
            "description": "Model ID used for the prediction.",
            "type": "string"
          },
          "outputs": {
            "description": "Array of URLs to the generated content. Empty when status is not completed.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "status": {
            "description": "Status of the task: created, processing, completed, or failed.",
            "type": "string"
          },
          "urls": {
            "description": "Object containing related API endpoints.",
            "type": "object"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.atlascloud.ai"
    }
  ]
}

LLM-Friendly Prompt Template

# atlascloud/face-swap-image

> Swap a face onto any photo. The facial identity is transferred while pose, clothing and background stay intact.


## Overview

- **Submit endpoint (POST)**: `https://api.atlascloud.ai/api/v1/model/generateImage` — start an async generation; returns a `prediction_id`
- **Poll endpoint (GET)**: `https://api.atlascloud.ai/api/v1/model/prediction/{prediction_id}` — poll this until the prediction finishes
- **Model ID**: `atlascloud/face-swap-image`


## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:

- **`model`** (`string`, _required_):
  Model name.
  - Default: `"atlascloud/face-swap-image"`

- **`image`** (`string`, _required_):
  ① 源脸 (Source Face) — 要换上去的那张脸，清晰正面照最佳。

- **`Image`** (`string`, _required_):
  ② 目标图 (Target Image) — 被换脸的照片，默认替换完整头部，保留身体、服装、姿势和背景。

- **`size`** (`string`, _optional_):
  Output image resolution/size. Use auto to detect the target image aspect ratio and choose the closest Seedream-supported size; explicit values are passed through when supported by the model.
  - Default: `"auto"`
  - Options: "auto", "2048*2048", "2304*1728", "1728*2304", "2720*1530", "1530*2720", "2496*1664", "1664*2496", "1024*1024", "1536*1536", "1776*1328", "1328*1776", "2048*1152", "1152*2048"

- **`output_format`** (`string`, _optional_):
  Output image format. Seedream v5.0 Pro supports jpeg and png.
  - Default: `"jpeg"`
  - Options: "jpeg", "png"



**Required Parameters Example**:

```json
{
  "model": "atlascloud/face-swap-image",
  "image": "",
  "Image": ""
}
```


**Full Example**:

```json
{
  "model": "atlascloud/face-swap-image",
  "image": "",
  "Image": "",
  "size": "auto",
  "output_format": "jpeg"
}
```


### Output Schema

The API returns the following output format:


- **`created_at`** (`string`, _optional_):
  ISO timestamp of when the request was created.

- **`id`** (`string`, _optional_):
  Unique identifier for the prediction.

- **`model`** (`string`, _optional_):
  Model ID used for the prediction.

- **`outputs`** (`array[string]`, _optional_):
  Array of URLs to the generated content. Empty when status is not completed.

- **`status`** (`string`, _optional_):
  Status of the task: created, processing, completed, or failed.

- **`urls`** (`object`, _optional_):
  Object containing related API endpoints.



**Example Response**:

```json
{
  "created_at": "",
  "id": "",
  "model": "",
  "outputs": [
    ""
  ],
  "status": "",
  "urls": {}
}
```


## Usage Examples

### cURL

```bash
# Step 1: Start generation (async)
curl -X POST "https://api.atlascloud.ai/api/v1/model/generateImage" \
  -H "Authorization: Bearer $ATLASCLOUD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "atlascloud/face-swap-image",
  "image": "",
  "Image": "",
  "size": "auto",
  "output_format": "jpeg"
}'

# Response will contain: {"code": 200, "data": {"id": "prediction_id", "status": "processing"}}

# Step 2: Poll for result (replace {prediction_id} with the id returned above)
curl -X GET "https://api.atlascloud.ai/api/v1/model/prediction/{prediction_id}" \
  -H "Authorization: Bearer $ATLASCLOUD_API_KEY"

# Keep polling until status is "completed", "succeeded" or "failed"
# When completed, outputs will contain the generated content URL(s)
```

## Additional Resources

### Documentation

- [Model Playground](https://www.atlascloud.ai/models/atlascloud/face-swap-image)

Face Swap (Image)

Swap a face onto any photo in one click.

Source Face — upload a clear, front-facing photo of the face you want to swap in.
Target Image — upload the photo whose face should be replaced.
Click Run.

The facial identity from the Source Face is transferred onto the Target Image while the original pose, body, clothing, background and lighting are preserved for a seamless, photorealistic result.

Face swapping involves real people. Only upload images you have the right to use and obtain consent from the people depicted. Do not use this tool to create misleading or harmful content.

Face Swap API by Atlas Cloud

INPUT

OUTPUT

Parameters

Code Example

Install

Authentication

HTTP Headers

Submit a request

Submit a Request

Request Body

Response

Check Status

Polling Example

Status Values

Completed Response

Upload Files

Upload Example

Response

Input Schema

Example Request Body

Output Schema

Example Response

Atlas Cloud Skills

Supported Clients

Install

Setup API Key

Capabilities

MCP Server

Supported Clients

Install

Configuration

Available Tools

API Schema

LLM-Friendly Prompt Template

Face Swap (Image)

Explore Similar Models

Z-Image-Turbo LoRA

Photo Cleanup

Openai GPT Image 2 Text-to-Image

Openai GPT Image 2 Edit

GPT Image 2 Developer Edit

GPT Image 2 Developer Text-to-Image

Seedream v5.0 Pro Edit

Seedream v5.0 Pro Text-to-Image

Nano Banana 2 Lite Edit Developer

Nano Banana 2 Lite Text-to-Image Developer

Nano Banana 2 Lite Edit

Nano Banana 2 Lite Text-to-image

MAI-Image-2.5-Flash Text-to-image

MAI-Image-2.5 Edit

MAI-Image-2.5 Text-to-image

Youchuan V8.1 Remove Background

One API for All Media AI.

Join our Discord community

INPUT

OUTPUT

Parameters

Code Example

Install

Authentication

HTTP Headers

Submit a request

Submit a Request

Request Body

Response

Check Status

Polling Example

Status Values

Completed Response

Upload Files

Upload Example

Response

Input Schema

Example Request Body

Output Schema

Example Response

Atlas Cloud Skills

Supported Clients

Install