v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB

Image Projects

Face Swap Photo

Create a face swap photo. Each photo costs 10 credits. The height/width of the output image depends on your subscription. Please refer to our pricing page for more details

post/v1/face-swap-photo

Request body

namestring

Give your image a custom name for easy identification.

Example request

{
  "name": "My Face Swap image",
  "assets": {
    "face_swap_mode": "all-faces",
    "source_file_path": "api-assets/id/1234.png",
    "face_mappings": [
      {
        "original_face": "api-assets/id/0-0.png",
        "new_face": "api-assets/id/1234.png"
      }
    ],
    "target_file_path": "api-assets/id/1234.png"
  }
}

Response

Success

idstring required

Unique ID of the image. Use it with the Get image Project API to fetch status and downloads.

credits_chargedinteger required

The amount of credits deducted from your account to generate the image. We charge credits right when the request is made.

If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.

Example response

{
  "id": "cuid-example",
  "credits_charged": 10
}