legacy/Face Swap
| API | Task-type | Model | Description | Input Limitation |
|---|
| Video Faceswap API | face-swap | Qubico/image-toolkit | Swap faces in the target video
sequentially using the chosen images. | Supports MP4 only (≤10MB,
≤720p, ≤600 frames). |
Face-Swapping Logic Based on Algorithmic Face Order#
The face-swapping sequence is determined by the model's algorithmic detection of faces. Generally, faces are labeled numerically in order - for example, 0 represents the leftmost face, 1 represents the next face to the right, and so on. The model assigns order labels to detected faces, and users can generally expect the API to sort faces from left to right by default.However, if faces in a photo/video are positioned diagonally (e.g., one at the top-left and another at the bottom-right), the model may prioritize them as follows:Top-left face → Labeled 1 (smaller)
Bottom-right face → Labeled 0 (larger)
Bottom-left face → Labeled 0
Top-right face → Labeled 1
Examples: How Face Indexing Affects Results#
Case 1#
swap_faces_index: 0 1
target_faces_index: 1 0
Action: The left face in the source image replaces the right face in the target video, and the right face in the source replaces the left face in the target.Case 2#
swap_faces_index: 0 1
target_faces_index: 0 1
Action: The left face in the source replaces the left face in the target; the right face in the source replaces the right face in the target.
| Task-type | Pricing |
|---|
| face-swap | $0.004 per frame |
Request
Body Params application/json
Upload the image URL into this parameter (the URL should end with '.png', '.jpeg', or Base64 string). The face in this image will be swapped out with the swap_image face.
Upload the image URL into this parameter (the URL should end with '.png', '.jpeg', or Base64 string). The face in this image will swapped be onto the target_image face.
The format should be: "url" or "base64". Default type is "base64".
{
"target_image": "Superman.png",
"swap_image": "Leonardo_Dicaprio.png",
"result_type": "url"
}
Request samples
curl --location --request POST 'https://api.piapi.ai/api/face_swap/v1/async' \
--header 'X-API-Key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"target_image": "Superman.png",
"swap_image": "Leonardo_Dicaprio.png",
"result_type": "url"
}'
Responses
{
"code": 200,
"data": {
"task_id": "7a7ba527************1974d4316e22"
},
"message": "success"
}
Modified at 2025-03-26 12:55:46
