Skip to main content
POST
/
api
/
portrait
/
effects
/
face-filter
Face Filters
curl --request POST \
  --url https://www.ailabapi.com/api/portrait/effects/face-filter \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image='@example-file' \
  --form 'resource_type=<string>' \
  --form 'strength=<string>'
{
  "request_id": "",
  "log_id": "",
  "error_code": 0,
  "error_code_str": "",
  "error_msg": "",
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "data": {
    "image_url": ""
  }
}

​
Request

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

​
Image requirements

  • Image format: JPEG JPG PNG BMP
  • Image size: No more than 3 MB.
  • Image resolution: Larger than 10x10px, smaller than 2000x2000px.

​
Headers

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

​
Body

FieldRequiredTypeScopeDescription
imageYESfile
resource_typeYESstringScopePicture style. More Details
strengthYESfloat[0, 1.0]Filter intensity.

​
resource_type

resource_typeDescription
10001White Tea
10002Fair Skin
10003Early Summer
10004Tokyo
10005Confession
10006Warm Sunshine
10007Rose
10008Clarity
10009Crystal Clear
10010Sweet Mint
10011Basic
10012Heartbeat
10013Muted Gray
10014Cherry Pudding
10015Natural
10016Elegance
10017Black and White
10018Fruit
10019Love
10020Winter
10021Photo
10022Summer
10023Fragrance
10024Charm
10025Throb
10026Beach
10027Street Snap
10028Sweet
10029First Kiss
10030Afternoon
10031Vitality
10032Hazy
10033Joyful
10034Fashion
10035Bubbles
10036Lemon
10037Cotton Candy
10038Brook
10039Beauty
10040Coffee
10041Tender Bud
10042Passion
10043Gradual Warmth
10044Breakfast
10045White Tea
10046Fair
10047Holy
10048Forest
10049Surfing
10050Milk Coffee
10051Clear
10052Breeze
10053Sunset
10054Water Glow
10055Japanese Style
10056Starlight
10057Sunshine
10058Falling Leaves
10059Vitality
10060Sweetheart
10061Elegance
10062Spring
10063Rome
10064Green
10065Gentle Breeze
10066Warm Heart
10067Seawater
10068Mysterious
10069Vintage 1
10070Vintage 2
10071Snowy Peak
10072Sunlight
10073Floating Clouds
10074Flowing Colors
10075Film
10076Nostalgia
10077Cheese
10078Butterfly

​
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

FieldTypeDescription
dataobjectThe content of the result data returned.
+image_urlstringResulting image URL address.
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

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

​
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
​
image
file
​
resource_type
string

Picture style.

​
strength
string

Filter intensity.

Response

200 - application/json

Success

The response is of type object.