Skip to main content
POST
/
api
/
portrait
/
effects
/
smart-beauty
Smart Beauty
curl --request POST \
  --url https://www.ailabapi.com/api/portrait/effects/smart-beauty \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form task_type=sync \
  --form 'multi_face=<string>' \
  --form 'beauty_level=<string>' \
  --form image_target=@example-file
{
  "request_id": "",
  "log_id": "",
  "error_code": 0,
  "error_code_str": "",
  "error_msg": "",
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_type": "sync",
  "result": ""
}

​
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

FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

​
Body

FieldRequiredTypeScopeDefaultDescription
image_targetYESfile
multi_faceNOstring , 1Multiple-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_levelNOfloat[0, 1]1Beauty level.
task_typeNOstringsyncsync“sync: Synchronous tasks.

​
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

FieldTypeScopeDescription
task_typestringsyncTask Type. “sync: Synchronous tasks.
dataobjectThe content of the result data returned.
+imagestringThe result image, returning the Base64 encoding of the image.

​
Response Example

{
   "request_id":     "",
   "log_id":         "",
   "error_code":     0,
   "error_msg":      "",
   "error_detail":   {
      "status_code":  200,
      "code":         "",
      "code_message": "",
      "message":      ""
   },
   "task_type":      "sync",
   "data":           {
      "image": ""
   }
}

​
Sample Code

👉 Online Experience 👈If you’d like to see the actual effects, please visit the experience page for a trial.

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
task_type
string

Task Type. <li>sync: Synchronous tasks.</li> <li>async: Asynchronous tasks.</li>

Example:

"sync"

​
image_target
file
​
multi_face
string

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
string

Beauty level.

Response

200 - application/json

Success

The response is of type object.