Website API Documentation

1. Obtaining API Keys

Before you can make API calls, you need to obtain your API key from the API Management Page.

2. Face Swap API

2.1 Face Swap

**POST api/aifaceswap/v1/faceswap**

Body Attributes

curl -X POST 'https://aifaceswap.io/api/aifaceswap/v1/faceswap' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
    "source_image": "https://temp.aifaceswap.io/aifaceswap/static_img/8a1bce5ea303791589165a5f607e7399.webp",
    "face_image": "https://temp.aifaceswap.io/aifaceswap/static_img/1f153b1ab8d134f1eff57eb527467137.webp",
    "webhook": "https://b245fc85af95.ngrok-free.app/api/aifaceswap/v1/task_callback"
}'

Note: If source_image or face_image is not a URL on the aifaceswap server, please provide the complete URL.

Response Example

{
  "code": 200,
  "data": {
    "points": 2,
    "task_id": "ac3eb7ab5852233a3d2076031103b4fe"
  },
  "extra_data": {},
  "message": "OK"
}

2.2 Extract Faces

**POST api/aifaceswap/v1/extract_face**

For multiple person face swaps, extract all faces from the image.

Body Attributes

curl -X POST 'https://aifaceswap.io/api/aifaceswap/v1/extract_face' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
    "img": "https://temp.aifaceswap.io/aifaceswap/static_img/1f153b1ab8d134f1eff57eb527467137.webp"
}'

Response Example

{
  "code": 200, 
  "data": {
    "faces": [
      [146, 256, 240, 381], 
      [297, 521, 371, 621], 
      [441, 208, 529, 332]
    ], 
    "points": 2
  }, 
  "message": "OK"
}

2.3 Multiple Face Swap

**POST api/aifaceswap/v1/multi_faceswap**

Replace one or more faces in an image containing multiple faces.

Body Attributes

curl -X POST 'https://aifaceswap.io/api/aifaceswap/v1/multi_faceswap' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
    "source_image": "https://art-global.yimeta.ai/aifaceswap/image/face_b07365091f488682662cbebc08721616.webp",
    "face_image": ["https://temp.aifaceswap.io/aifaceswap/static_img/8a1bce5ea303791589165a5f607e7399.webp", "https://temp.aifaceswap.io/aifaceswap/static_img/1f153b1ab8d134f1eff57eb527467137.webp"],
    "index": [0, 2],
    "webhook": "https://698f-221-234-179-244.ngrok-free.app/api/aifaceswap/v1/task_callback"
}'

Response Example

{
    "code": 200,
    "data": {
        "points": 5,
        "task_id": "6c3ce398d9e2bdd6abed6d636ec2ac03"
    },
    "message": "OK"
}

2.4 Webhook Definition

When the results are generated, the aifaceswap server will call the webhook to return the results. Therefore, developers need to define an API endpoint for this purpose.

**POST https:xxxx.xx/api/task_callback**

Body Attributes

3. Video Face Swap API

3.1 Basic Video Face Swap

**POST api/aifaceswap/v1/video_faceswap**

Body Attributes

curl -X POST 'https://aifaceswap.io/api/aifaceswap/v1/video_faceswap' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
    "source_video": "https://temp.aifaceswap.io/aifaceswap/image/videoswap-template/3-b800d4689751060d3765a58518c26c1a.mp4",
    "face_image": "https://temp.aifaceswap.io/aifaceswap/static_img/1f153b1ab8d134f1eff57eb527467137.webp",
    "duration": 5,
    "enhance": 0,
    "webhook": "https://b245fc85af95.ngrok-free.app/api/aifaceswap/v1/task_callback"
}'

Response Example

{
  "code": 200,
  "data": {
    "points": 10,
    "task_id": "30d22e3a163d023a40e3e13327999ce3"
  },
  "extra_data": {},
  "message": "OK"
}

3.2 Extract Faces From Video Frame

**POST api/aifaceswap/v1/extract_base64_face**

Note: This api is only used for Multi Video Face Swap. Extract face points from a certain frame of the video.

Body Attributes

curl -X POST 'https://aifaceswap.io/api/aifaceswap/v1/extract_base64_face' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
    "base64_img": "data:image/webp;base64,UklGRtDnA..."
}'

Response Example

{
    "code": 200,
    "data": {
        "pos": [
              [
                  568,
                  332,
                  655,
                  476
              ],
              [
                  1078,
                  170,
                  1169,
                  290
              ],
        ]
    },
    "extra_data": {},
    "message": "OK"
}

3.3 Multiple Video Face Swap

**POST api/aifaceswap/v1/multi_video_faceswap**

Body Attributes

Body Attributes of "ref_image"

curl -X POST 'https://aifaceswap.io/api/aifaceswap/v1/multi_video_faceswap' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
    "source_video": "https://temp.aifaceswap.io/aifaceswap/image/videoswap-template/3-b800d4689751060d3765a58518c26c1a.mp4",
    "ref_info": [
        {
            "face_ref": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA...",
        "face_url": "https://temp.aifaceswap.io/aifaceswap/static_img/1f153b1ab8d134f1eff57eb527467137.webp"
        }
    ],
    "duration": 5,
    "enhance": 0,
    "webhook": "https://14e47e61df64.ngrok-free.app/api/aifaceswap/v1/task_callback"
}'

Note: Multiple video face swapping supports up to 3 faces. So the maximum length of ref_info is no more than 3.

Response Example

{
  "code": 200,
  "data": {
    "points": 20,
    "task_id": "59c71eb51b181d56dfbb5e9e3fb6832d"
  },
  "extra_data": {},
  "message": "OK"
}

4. Pricing

5. FAQ