AI Face Swap API

Request

URL: https://www.ailabapi.com/api/portrait/editing/ai-face-swap
Method: POST
Content-Type: multipart/form-data

API Information

Field	Value
API Name	`AI Face Swap`
API URL	`/api/portrait/editing/ai-face-swap`
Documentation URL	`/docs/ai-portrait/editing/ai-face-swap`
Unique Identification	`portrait_ai_face_swap`

Image requirements

Field	Requirements
`image_target`	`Image format: JPEG/JPG/PNG`, `Image size: No more than 5 MB.`, `Image resolution: Less than 4096x4096px.`
`image_template`	`Image format: JPEG/JPG/PNG`, `Image size: No more than 5 MB.`, `Image resolution: Less than 4096x4096px.`

Headers

Field	Required	Type	Description
`ailabapi-api-key`	YES	`string`	Application API KEY. Get API KEY

Body

Field	Required	Type	Description
`image_target`	YES	`file`	Target portrait image. The face in this image will be replaced.
`image_template`	YES	`file`	Template portrait image that provides the face to swap.

This API is asynchronous. Submit the request, keep the returned task_id, and call Querying Async Task Results to obtain the final image result.

Response

Response Field Handling Flow

Handle Public Response Fields Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.
Handle Business Response Fields If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

Public Response Fields

Viewing Public Response Fields and Error Codes

Business Response Fields

Field	Type	Scope	Description
`task_type`	`string`	`async`	Task Type. “async`: Asynchronous tasks.`
`task_id`	`string`		Asynchronous task ID. Please use this field when calling the Querying Async Task Results API.

Response Example

{
  "request_id": "",
  "log_id": "",
  "error_code": 0,
  "error_msg": "",
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_type": "async",
  "task_id": ""
}

`Querying Async Task Results` Response

Response Field Handling Flow

Handle Public Response Fields Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.
Handle Business Response Fields If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

Public Response Fields

Viewing Public Response Fields and Error Codes

Business Response Fields

Field	Type	Scope	Description
`task_status`	`integer`	`0`, `1`, `2`	Asynchronous task status. 0`: The task is queued.` 1`: Asynchronous processing.` “2`: Processing was successful.`
`data`	`object`		The result payload returned by the asynchronous task.
+`image`	`string`		Result image URL.

All result URLs are temporarily available and will expire after 24 hours.

Response Example

{
  "error_code": 0,
  "error_msg": "",
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_status": 2,
  "data": {
    "image": "https://***.jpg"
  }
}

Preface

Quick Start

AI Common

AI Portrait

AI Image

AI Background Removal

Request

API Information

Image requirements

Headers

Body

Response

Public Response Fields

Business Response Fields

Response Example

`Querying Async Task Results` Response

Public Response Fields

Business Response Fields

Response Example

​Request

​API Information

​Image requirements

​Headers

​Body

​Response

​Public Response Fields

​Business Response Fields

​Response Example

​Querying Async Task Results Response

​Public Response Fields

​Business Response Fields

​Response Example

Request

API Information

Image requirements

Headers

Body

Response

Public Response Fields

Business Response Fields

Response Example

`Querying Async Task Results` Response

Public Response Fields

Business Response Fields

Response Example