[Important: API Service Retirement Announcement]Dear Developers,Thank you for your continued trust and support in AILabTools API. In order to provide more efficient and reliable services, we will officially deprecate the current version of this API.As this interface is based on an outdated architecture and its performance can no longer meet evolving needs, it will no longer be available starting from the date of this announcement.We kindly recommend that you evaluate and adopt an alternative solution as soon as possible to ensure a smooth transition for your applications.If you have any questions or need assistance during the migration, please feel free to contact our support team:
📧 [email protected]We sincerely appreciate your understanding and cooperation, and we remain committed to delivering better and more advanced services for you.Warm regards,AILabTools Support Team
Request
- URL:
https://www.ailabapi.com/api/portrait/effects/hairstyle-editor-pro - Method:
POST - Content-Type:
multipart/form-data
Image requirements
- Image format:
PNGJPGJPEG - Image size: No more than 3 MB.
- Image resolution: Larger than 200x200px, smaller than 2000x2000px.
- Minimum Face Proportion: To ensure effectiveness, the proportion of the face in the image cannot be less than 20%.
- Facial Integrity: To ensure effectiveness, the face in the image should ideally not be obscured.
- Facial Angle: To ensure effectiveness, the face in the image should ideally be front-facing, with no more than a 45-degree rotation to the left or right.
| Image Validity | Reason for Invalidity | |
|---|---|---|
| ✅ | ||
| ❌ | No face | |
| Incomplete face | ||
| Face obscured | ||
| Face proportion too small | ||
| The face is too large to edit the hairstyle |
Headers
| Field | Required | Type | Description |
|---|---|---|---|
ailabapi-api-key | YES | string | Application API KEY. Get API KEY |
Body
Fixed Fields
| Field | Required | Type | Scope | Default | Description |
|---|---|---|---|---|---|
task_type | YES | string | async | “async: Asynchronous tasks. | |
image | YES | file | Main image. | ||
hair_style | YES | string | Scope | Hairstyle. More Details | |
color | NO | string | Scope | Color. More Details | |
image_size | NO | integer | 1, 2, 3, 4 | 1 | Returns the number of images. |
mask | NO | file | Masked Image. If left blank, a masked image will be generated automatically. The white portion of the masked image is the editable area, while the black portion remains unchanged. For example, by using the white area of the mask to cover a person’s face, the face will remain unaltered, and other parts will be generated automatically. | ||
bangs | NO | integer | 0, 1 | 1 | 0`: No.`, 1: Yes., [Parameter Effect Comparison](#bangsCompared) |
mode | NO | integer | 1, 2 | 1 | 1`: Head-only mode. More suitable for short hair.`, 2: Full-image generation mode. More suitable for long hair; use this mode when the original image features shoulder-length or longer hair., [Parameter Effect Comparison](#modeCompared) |
reference | NO | integer | 0, 1 | 0 | 0`: No.`, 1: Yes., [Parameter Effect Comparison](#referenceCompared) |
hair_style
| Category: Gender | Category: Length | hair_style | Description | Validity of the ‘bangs’ Field |
|---|---|---|---|---|
| Male | Short | BuzzCut | Buzz Cut hair | Ineffective |
| UnderCut | UnderCut hair | Ineffective | ||
| Pompadour | Pompadour hair | Ineffective | ||
| SlickBack | Slick Back hair | Ineffective | ||
| CurlyShag | Curly Shag hair | Effective | ||
| WavyShag | Wavy Shag hair | Effective | ||
| FauxHawk | Faux Hawk hair | Ineffective | ||
| Spiky | Spiky hair | Ineffective | ||
| CombOver | Comb-over hair | Effective | ||
| HighTightFade | High and Tight Fade hair | Ineffective | ||
| ManBun | Man Bun hair | Ineffective | ||
| Afro | Afro hair | Effective | ||
| LowFade | Low Fade hair | Effective | ||
| UndercutLongHair | Undercut With Long Hair | Ineffective | ||
| TwoBlockHaircut | Two Block Haircut | Effective | ||
| TexturedFringe | Textured Fringe Hair | Effective | ||
| BluntBowlCut | Blunt Bowl Cut | Ineffective | ||
| Middle | LongWavyCurtainBangs | Long Wavy Curtain Bangs Hair | Effective | |
| MessyTousled | Messy Tousled hair | Effective | ||
| MediumLengthWavy | Medium Length Wavy hair | Effective | ||
| Long | CornrowBraids | Cornrow Braids hair | Ineffective | |
| LongHairTiedUp | Long Hair Tied Up Hair | Ineffective | ||
| Female | Short | ShortPixieWithShavedSides | Short Pixie With Shaved Sides | Effective |
| ShortNeatBob | short neat bob hair | Effective | ||
| DoubleBun | double bun hair | Effective | ||
| Updo | Updo hair | Effective | ||
| Spiked | spiked hair | Effective | ||
| bowlCut | bowl cut hair | Effective | ||
| Chignon | Chignon hair | Ineffective | ||
| PixieCut | Pixie Cut hair | Effective | ||
| SlickedBack | slicked back hair | Ineffective | ||
| Middle | LongCurly | Long curly hair | Effective | |
| CurlyBob | Curly bob hair | Effective | ||
| StackedCurlsInShortBob | Stacked Curls in Short Bob hair | Effective | ||
| SidePartCombOverHairstyleWithHighFade | Side Part Comb-Over Hairstyle With High Fade hair | Ineffective | ||
| WavyFrenchBobVibesfrom1920 | Wavy French Bob Vibes from 1920 | Effective | ||
| BobCut | bob Haircut hair | Ineffective | ||
| ShortTwintails | Short Twintails hair | Effective | ||
| ShortCurlyPixie | Short Curly Pixie | Effective | ||
| Long | LongStraight | Long straight hair | Effective | |
| LongWavy | Long wavy hair | Effective | ||
| FishtailBraid | Fishtail braid hair | Effective | ||
| TwinBraids | Twin Braids hair | Ineffective | ||
| Ponytail | Ponytail hair | Effective | ||
| Dreadlocks | dreadlocks hair | Ineffective | ||
| Cornrows | Cornrows hair | Ineffective | ||
| ShoulderLengthHair | Shoulder Length Straight Hair | Effective | ||
| LooseCurlyAfro | Loose Curly Afro hair | Effective | ||
| LongTwintails | Long Twintails hair | Ineffective |
color
color | Description |
|---|---|
blonde | blonde hair |
platinumBlonde | platinum blonde hair |
brown | brown hair |
lightBrown | light brown hair |
blue | blue hair |
lightBlue | light blue hair |
purple | purple hair |
lightPurple | light purple hair |
pink | pink hair |
black | black hair |
white | white hair |
grey | grey hair |
silver | silver hair |
red | red hair |
orange | orange hair |
green | green hair |
gradient | gradient hair |
multicolored | multicolored hair |
darkBlue | dark blue hair |
burgundy | burgundy hair |
darkGreen | dark green hair |
bangs: Parameter Effect Comparison
When the ‘bangs’ field is valid
| Hairstyle | bangs | Original | Result |
|---|---|---|---|
| Short Pixie With Shaved Sides | 0 |  |  |
| Short Pixie With Shaved Sides | 1 | |  |
When the ‘bangs’ Field Is Invalid
| Hairstyle | bangs | Original | Result |
|---|---|---|---|
| slicked back hair | 0 | |  |
| slicked back hair | 1 | |  |
mode: Parameter Effect Comparison
| Hairstyle | mode | Original | Result |
|---|---|---|---|
| double bun hair | 1 |  |  |
| double bun hair | 2 | |  |
reference: Parameter Effect Comparison
| Hairstyle | reference | Original | Result |
|---|---|---|---|
| Medium Length Wavy hair | 0 |  |  |
| Medium Length Wavy hair | 1 | |  |
Response
Response Field Handling Flow-
Handle
Public Response FieldsParse and validate thePublic Response Fields, checking the status code or response message to ensure the request is successful and error-free. -
Handle
Business Response FieldsIf thePublic Response Fieldsare valid and error-free, proceed with processing the business logic in theBusiness Response Fields.
Public Response Fields
Viewing Public Response Fields and Error CodesBusiness 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
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
-
Handle
Public Response FieldsParse and validate thePublic Response Fields, checking the status code or response message to ensure the request is successful and error-free. -
Handle
Business Response FieldsIf thePublic Response Fieldsare valid and error-free, proceed with processing the business logic in theBusiness Response Fields.
Public Response Fields
Viewing Public Response Fields and Error CodesBusiness 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. | |
+images | array | Array of resultant image addresses. |