Video multi-face swap
Face Swap
Video Face Swap (Multi)
Replace selected faces in a video by mapping detection face IDs to target face images.
POST
Video multi-face swap
Overview
Video multi-face swap replaces one or more faces by face ID. Create a detection task first, query the detection result to getdetect_id and the faces list, then use the faces array in the swap request to map each face to its target image.
Process Flow
Create a detection task
Call the face detection endpoint with the video URL you want to swap.
Query detection result
Call the face detection result endpoint to get
result.id as detect_id, and read face IDs and face images from result.faces.Request Example
face_id’s target as the detected face image URL returned by the previous step.
Parameters
Detection result ID returned by
data.result.id from the face detection result endpoint.URL of the target video. It must match the media URL used for detection.
An array describing which faces should be replaced. Each item contains
face_id and target.The ID of the face from detection results.
The target face image URL. Use a new face image URL to replace the face, or keep the detected face image URL if you do not want to replace it.
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
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 video-face-swap-multi.
Available options:
video-face-swap-multi Input parameters for multi-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"
