Create Task - Faceswap API

This async endpoint from PiAPI's Faceswap API swaps the face from the swap_image to the target_image.

INFO

This async endpoint from PiAPI's Faceswap API swaps the face from the swap_image onto the target_image.

Format & Constraints

Size & Resolution: both swap_image and target_image should be under 2048 x 2048 resolution each.
Input Format: both swap_image and target_image should be passed in as urls (ending in jpg/jpeg/png/webp) or in base64 string.

The face-swapping logic operates based on the sequential order of faces detected by the algorithm, with the model assigning numeric labels from 0 to n. While users can generally expect the API to sort faces in a left-to-right order, diagonal face positioning in photos may alter this sequence.

For instance, when one face appears in the upper-left and another in the lower-right, the model might label the upper-left face as 1 and the lower-right as 0. conversely, a lower-left face could be labeled 0 while an upper-right face becomes 1. This positional variation in labeling occurs due to the algorithm's spatial evaluation of face arrangements within the frame.

Request

Header Params

x-api-key

string

required

Your API Key used for request authorization

Body Params application/json

model

string

required

task_type

string

required

input

object

required

target_image

string

required

swap_image

string

required

config

object

optional

webhook_config

object

optional

Webhook provides timely task notifications. Check PiAPI webhook for detail.

service_mode

enum<string>

optional

This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.

public means this task will be processed under PAYG mode.

private means this task will be processed under HYA mode.

Allowed values:

publicprivate

Example

{
  "model": "Qubico/image-toolkit",
  "task_type": "face-swap",
  "input": {
    "target_image": "https://i.ibb.co/LnLYwhR/66f41e64b1922.jpg",
    "swap_image": "https://i.ibb.co/m9BFL9J/ad61a39afd9079e57a5908c0bd9dd995.jpg"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

code

integer

required

data

object

required

task_id

string

required

model

string

required

task_type

string

required

status

enum<string>

required

Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged

Allowed values:

CompletedProcessingPendingFailedStaged

input

object

required

output

object

required

meta

object

required

detail

null

required

logs

array [object]

required

error

object

required

message

string

required

If you get non-null error message, here are some steps you chould follow:

Check our common error message

Retry for several times

If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.

Example

{
  "code": 200,
  "data": {
    "task_id": "90efd2db-bcfc-413f-a0be-c893850c9d68",
    "model": "Qubico/image-toolkit",
    "task_type": "face-swap",
    "status": "pending",
    "config": {
      "webhook_config": {
        "endpoint": "",
        "secret": ""
      }
    },
    "input": {},
    "output": null,
    "meta": {},
    "detail": null,
    "logs": [],
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  },
  "message": "success"
}

Image Faceswap

Format & Constraints

Request

Request samples

Responses