Skip to main content
POST
Image face swap

Overview

Single image face swap replaces the primary face in an image with a new face image. This endpoint does not require face detection first; submit the original image URL and the new face image URL directly.
Multi-face swap still requires a detection step and a detect_id.

Request Example

Parameters

image_url
string
required
URL of the target image where the face will be replaced.
new_face
string
required
URL of the new face image.

Query Task Status

After submitting a task, use the unified query endpoint to check progress and retrieve results:

Get Task Info

Learn how to query task status and retrieve generation results
For production use, we recommend using callback_url to receive automatic notifications when the task completes, rather than polling the status endpoint.

Image Multi-Face Swap

Replace selected faces in an image using detection results

Face Detection Result

Query detection status and retrieve detect_id with detected faces

Common API

Check credits and account usage

Authorizations

x-api-key
string
header
required

All APIs require authentication via API Key.

Get API Key:

  1. Visit API Key Management Page to get your API Key

Usage: Add to request header:

x-api-key: YOUR_API_KEY

Note:

  • Keep your API Key secure and do not share it with others
  • If you suspect your API Key has been compromised, reset it immediately in the management page

Body

application/json
model
enum<string>
required

The model name to use for this endpoint. Must be image-face-swap.

Available options:
image-face-swap
input
object
required

Input parameters for single image face swap.

callback_url
string<uri>

Optional. Callback URL for receiving task completion notifications.

Example:

"https://your-domain.com/api/callback"

Response

Request successful

code
enum<integer>

Response status code

  • 200: Success - Request has been processed successfully
  • 401: Unauthorized - Authentication credentials are missing or invalid
  • 402: Insufficient Credits - Account does not have enough credits to perform the operation
  • 404: Not Found - The requested resource or endpoint does not exist
  • 422: Validation Error - The request parameters failed validation checks
  • 429: Rate Limited - Request limit has been exceeded for this resource
  • 455: Service Unavailable - System is currently undergoing maintenance
  • 500: Server Error - An unexpected error occurred while processing the request
  • 501: Generation Failed - Content generation task failed
  • 505: Feature Disabled - The requested feature is currently disabled
Available options:
200,
401,
402,
404,
422,
429,
455,
500,
501,
505
message
string

Response message, error description when failed

Example:

"success"

data
object