AILabTools API - Smart Beauty - Async API

Request

• URL: https://www.ailabapi.com/api/portrait/effects/smart-beauty
• Method: POST
• Content-Type: multipart/form-data

Image requirements

• Image format: JPEG JPG BMP 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	Scope	Default	Description
task_type	YES	string	async		Task Type. async: Asynchronous tasks.
image_target	YES	file
multi_face	NO	string	1		Multiple-face beauty strategy. When set to 1, beauty enhancement is applied to all faces (it is recommended that the number of faces in the image be less than 18, as too many faces may lead to instability). When set to any other value or not specified, only the largest face is processed.
beauty_level	NO	float	[0, 1]	1	Beauty level.

Response

Response Field Handling Flow

1. 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.

2. 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.

Response Example

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

tip

This API is asynchronous, please keep task_id and call Querying Async Task Results to get the final results.

Asynchronous task results are valid for 24 hours. It is recommended that asynchronous task results be queried every 5 seconds.

Querying Async Task Results Response

Response Field Handling Flow

1. 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.

2. 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 content of the result data returned.
image_url	string		Result URL address.

tip

The URL address is a temporary address, valid for 24 hours, and will not be accessible after it expires. If you need to save the file for a long time or permanently, please visit the URL address within 24 hours and download the file to your own storage space.

Response Example

{
  "error_code":     0,
  "error_code_str": "",
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "task_status":    0,
  "data":           {
    "image_url": ""
  }
}

Sample Code

👉 Online Experience 👈

If you'd like to see the actual effects, please visit the experience page for a trial.

• Introduction to Get Sample Code
• Sample Code