Image Face Swap
Playground
You can use image-face-swap to swap faces in photos. With image-face-swap, you can swap your face with your friends, celebrities, or even historical figures.
Features
You can use image-face-swap to swap faces in photos. With image-face-swap, you can swap your face with your friends, celebrities, or even historical figures.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
# Submit the task
curl --location --request POST "https://api.wavespeed.ai/api/v3/wavespeed-ai/image_face_swap" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${WAVESPEED_API_KEY}" \
--data-raw '{
"image": "https://d1q70pf5vjeyhc.wavespeed.ai/media/images/1752546604367620589_qF0WTQOJ.jpeg",
"face_image": "https://d1q70pf5vjeyhc.wavespeed.ai/media/images/1752546643736831648_IVfDAxtq.jpeg",
"target_index": 0,
"output_format": "jpeg",
"enable_base64_output": false,
"enable_safety_checker": true,
"enable_sync_mode": false
}'
# Get the result
curl --location --request GET "https://api.wavespeed.ai/api/v3/predictions/${requestId}/result" \
--header "Authorization: Bearer ${WAVESPEED_API_KEY}"
Submit Task & Query Result
Parameters
Task Submission Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| image | string | Yes | - | The URL of the image that contains the face to be replaced. | |
| face_image | string | Yes | https://d1q70pf5vjeyhc.wavespeed.ai/media/images/1752546643736831648_IVfDAxtq.jpeg | - | The URL of the face image as reference. |
| target_index | integer | No | - | 0 ~ 10 | 0 = largest face. To switch to another target face - switch to index 1, e.t.c. |
| output_format | string | No | jpeg | - | The format of the output image. |
| enable_base64_output | boolean | No | false | - | If enabled, the output will be encoded into a BASE64 string instead of a URL. This property is only available through the API. |
| enable_safety_checker | boolean | No | true | - | If set to true, the safety checker will be enabled. |
| enable_sync_mode | boolean | No | false | - | If set to true, the function will wait for the image to be generated and uploaded before returning the response. It allows you to get the image directly in the response. This property is only available through the API. |
Request Parameters
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data.id | string | Unique identifier for the prediction, Task Id |
| data.model | string | Model ID used for the prediction |
| data.outputs | array | Array of URLs to the generated content (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.urls.get | string | URL to retrieve the prediction result |
| data.has_nsfw_contents | array | Array of boolean values indicating NSFW detection for each output |
| data.status | string | Status of the task: created, processing, completed, or failed |
| data.created_at | string | ISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”) |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |