Skip to main content
POST
Specific face swap in image

Request

Make a POST request to below endpoint and pass the required parameters in the request body.
curl

Body

json

Body

application/json
key
string
required

Your API Key used for request authorization

init_image
string<uri>
required

The initial image containing the face to replace

target_image
string<uri>
required

The target image containing the face to be swapped

reference_image
string<uri>
required

A reference image containing the specific face to swap from the initial image

watermark
boolean
default:true

Indicates if the generated result should include a watermark

webhook
string<uri> | null

A URL to receive a POST API call once the image generation is complete

base64
boolean
default:false

Input image is base64 format

track_id
integer | null

An ID included in the webhook response to identify the request

Response

Face swap response

status
enum<string>
Available options:
success
generationTime
number

Time taken to generate the result in seconds

id
integer

Unique identifier for the generation request

output
string<uri>[]

Array of URLs to the generated images

Array of proxy URLs for the generated images

meta
object

Metadata about the generation process and parameters used