Image face swap
Face Swap
Image Face Swap
Replace the primary face in an image without a prior detection step.
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.Request Example
Parameters
URL of the target image where the face will be replaced.
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
Related Resources
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 facesCommon API
Check credits and account usage
Authorizations
All APIs require authentication via API Key.
Get API Key:
- 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
The model name to use for this endpoint. Must be image-face-swap.
Available options:
image-face-swap Input parameters for single image face swap.
Optional. Callback URL for receiving task completion notifications.
Example:
"https://your-domain.com/api/callback"
Response
Request successful
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 Response message, error description when failed
Example:
"success"
