AILabTools API - Face Filters - API:V1.0.0(DEPRECATED)

---

draft: true

Important Announcement: API Version Update Notice

Dear Developers,

We are thrilled to announce that our API is receiving a major update! The new version will introduce a host of improvements and feature enhancements to enhance your development experience and meet your needs.

However, along with the rollout of the new version, we must also inform you that the old version of the API will no longer receive maintenance and support. This means that we will no longer release new features, fix known issues, or provide technical support for the old version of the API.

We strongly encourage you to upgrade to the latest version of the API as soon as possible to ensure that your applications continue to operate smoothly and to take advantage of the latest features and optimizations.

If you have any questions or need assistance regarding this change, please feel free to contact our support team ([email protected]). We are committed to assisting you and ensuring a smooth transition.

Once again, thank you for your support and trust in our API.

Best Regards,

AILabTools Support Team

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.

Header

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

Body

Field	Required	Type	Scope	Description
image	YES	file
resource_type	YES	string	Scope	Picture style. More Details
strength	YES	float	[0, 1.0]	Filter intensity.

resource_type

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

Response

Processing Flow

1. Handle Public Parameters:

   First, parse and validate the Public Parameters, checking the status code or response message to ensure the request is successful and no errors are present.

2. Handle Business Parameters:

   If the public parameters are valid and no exceptions are found, proceed to process the business logic in the Business Parameters.

Public Parameters

Viewing Public Parameters and Error Codes

Business Parameters

Field	Type	Description
data	object	The content of the result data returned.
+image_url	string	Resulting image 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.

Example

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

Code example

👉 Online Experience 👈

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

• Introduction
• Code example