{
"openapi": "3.0.0",
"info": {
"title": "AILabAPI",
"description": "[AILabTools](https://www.ailabtools.com) is an advanced tool that offers a vast array of simple and flexible API endpoints to suit your specific needs. With just one [API KEY](https://www.ailabtools.com/doc/get-api-key), you can easily call any of the endpoints and integrate them quickly into your application or workflow, allowing for smooth and efficient operations.\n\n[AILabTools](https://www.ailabtools.com) is continuously evolving, and you can anticipate even more API endpoints being added in the future, further enhancing its capabilities and usefulness for your artificial intelligence and machine learning requirements.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://www.ailabapi.com",
"description": "Production server"
}
],
"components": {
"securitySchemes": {
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "ailabapi-api-key",
"description": "API Key for authentication"
}
},
"schemas": {
"ErrorDetail": {
"type": "object",
"required": [
"code",
"code_message",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Error Code. See [Error Codes](/docs/response-description#error-codes)."
},
"code_message": {
"type": "string",
"description": "Error summary."
},
"message": {
"type": "string",
"description": "Detailed error message."
}
}
},
"PublicResponseFields": {
"type": "object",
"required": [
"request_id",
"log_id",
"error_detail"
],
"properties": {
"request_id": {
"type": "string",
"description": "Request ID for debugging."
},
"log_id": {
"type": "string",
"description": "Log ID for debugging."
},
"error_detail": {
"$ref": "#/components/schemas/ErrorDetail"
}
}
},
"AsyncTaskId": {
"type": "string",
"description": "Task ID for querying [Querying Async Task Results](/docs/ai-common/async-task-results/api)."
}
}
},
"security": [
{
"apiKeyAuth": []
}
],
"tags": [
{
"name": "AI IMAGE"
},
{
"name": "AI IMAGE > Image Enhancement"
},
{
"name": "AI IMAGE > Image Effects"
},
{
"name": "AI IMAGE > Image Editing"
},
{
"name": "AI IMAGE > Image Scoring"
},
{
"name": "AI BACKGROUND REMOVAL"
},
{
"name": "AI BACKGROUND REMOVAL > Portrait"
},
{
"name": "AI BACKGROUND REMOVAL > General"
},
{
"name": "AI PORTRAIT"
},
{
"name": "AI PORTRAIT > Portrait Effects"
},
{
"name": "AI PORTRAIT > Portrait Enhance"
},
{
"name": "AI PORTRAIT > Portrait Editing"
},
{
"name": "AI PORTRAIT > Portrait Analysis"
},
{
"name": "AI COMMON"
}
],
"paths": {
"/api/common/query-credits": {
"get": {
"tags": [
"AI COMMON"
],
"summary": "Querying Credits",
"description": "Query API credit balances, purchased credits, warning thresholds, and update times for each API identifier.",
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"description": "Credit entries grouped by API.",
"items": {
"type": "object",
"required": [
"unique_sign",
"name",
"balance",
"total",
"last_recharge_balance",
"balance_warning",
"first_buy_time",
"last_update_time"
],
"properties": {
"unique_sign": {
"type": "string",
"description": "Unique Identification. See [Unique Identification](/docs/ai-common/querying-credits/api#api-identifier)."
},
"name": {
"type": "string",
"description": "Name."
},
"balance": {
"type": "number",
"format": "float",
"description": "Current credit balance."
},
"total": {
"type": "number",
"format": "float",
"description": "Total purchased credits."
},
"last_recharge_balance": {
"type": "number",
"format": "float",
"description": "Credit balance after the last recharge."
},
"balance_warning": {
"type": "number",
"format": "float",
"description": "Low-balance alert threshold."
},
"first_buy_time": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp of the first purchase."
},
"last_update_time": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp of the last balance update."
}
}
}
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"data": [
{
"unique_sign": "",
"name": "",
"balance": 0,
"total": 0,
"last_recharge_balance": 0,
"balance_warning": 0,
"first_buy_time": 0,
"last_update_time": 0
}
]
}
}
},
"description": "Success"
}
}
}
},
"/api/common/query-async-task-result": {
"get": {
"tags": [
"AI COMMON"
],
"summary": "Querying Async Task Results",
"description": "Query asynchronous task results by task ID, including task status and final result data when processing is complete.",
"parameters": [
{
"name": "task_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "The task_id returned by the asynchronous API."
}
],
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_status"
],
"properties": {
"task_status": {
"type": "integer",
"enum": [
0,
1,
2
],
"description": "Task status. \n- `0`: queued. \n- `1`: processing. \n- `2`: completed."
},
"data": {
"type": "object",
"description": "Result payload. Available when `task_status` is `2`. Structure depends on the async API."
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_status": 0
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/portrait-animation": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Cartoon Yourself",
"description": "Cartoon Yourself API turns portraits into cartoon, anime, Pixar, 3D, pencil, and comic-style images with AI.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"type": {
"type": "string",
"description": "Cartoon effect. `jpcartoon`: Japanese Manga (I) `anime`: Japanese Manga (II) `claborate`: Chinese fine brushwork painting `hongkong`: Hong Kong-style comic style `comic`: Comic `animation3d`: 3D Animation `handdrawn`: hand-painted `sketch`: Pencil drawing (I) `full`: Pencil drawing (II) `artstyle`: Artistic effects `classic_cartoon`: Retro Cartoon `tccartoon`: Moe Manga `hkcartoon`: China Comics `3d_cartoon`: 3D cartoon `pixar`: Pixar `pixar_plus`: Pixar Pro `angel`: Angel `angel_plus`: Angel Pro `demon`: Demon `ukiyoe_cartoon`: Ukiyo-e `amcartoon`: American Manga `3d`: 3D Effects `3d_game`: 3D game effects `western`: Western `avatar`: Avatar `head`: Pencil drawing (head)"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/face-fusion": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Merge Portraits",
"description": "Merge Portraits API blends faces from target and template images using AI face fusion for realistic portrait composites.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image_target": {
"type": "string",
"description": "Target image.",
"format": "binary"
},
"image_template": {
"type": "string",
"description": "Template images.",
"format": "binary"
},
"source_similarity": {
"type": "string",
"description": "Face similarity, where a higher numerical value indicates greater similarity. `0`: Consistent with the original template. `1`: Maximum similarity with the target image."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"image": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/smart-beauty": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Smart Beauty",
"description": "Smart Beauty API retouches portraits with skin whitening, smoothing, face slimming, facial feature adjustment, and makeup effects.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `sync`: Synchronous tasks. `async`: Asynchronous tasks.",
"example": "sync"
},
"image_target": {
"type": "string",
"format": "binary"
},
"multi_face": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Beauty level."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "Sync",
"value": {
"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": ""
}
},
"example-1": {
"summary": "Async",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/smart-skin": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Skin Enhancement",
"description": "AI Skin Enhancement API smooths skin, removes blemishes, and brightens faces and bodies while preserving natural skin texture.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"retouch_degree": {
"type": "string",
"description": "Dermabrasion intensity. The higher the value, the less visible the skin texture."
},
"whitening_degree": {
"type": "string",
"description": "Whitening strength. The higher the value, the whiter the skin."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/smart-skin-advanced": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Skin Enhancement Advanced",
"description": "AI Skin Enhancement Advanced API removes acne, wrinkles, pores, spots, eye bags, and uneven tone while preserving natural skin texture.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"smart_skin": {
"type": "string",
"description": "Smart all-in-one skin beautification. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"acne_removal": {
"type": "string",
"description": "Acne and blemish removal. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"spot_correction": {
"type": "string",
"description": "Spot and pigmentation correction. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"skin_brightening": {
"type": "string",
"description": "Skin brightening and tone enhancement. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"skin_smoothing": {
"type": "string",
"description": "Skin smoothing and refinement. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"pore_control": {
"type": "string",
"description": "Pore and oil control. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"wrinkle_reduction": {
"type": "string",
"description": "Wrinkle and fine-line reduction. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"under_eye_correction": {
"type": "string",
"description": "Under-eye correction. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
},
"scar_reduction": {
"type": "string",
"description": "Scar and skin damage reduction. \n- `0`: No. \n- `1`: Yes.",
"enum": [
0,
1
],
"default": 0
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/smart-face-slimming": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Face Slimming",
"description": "AI Face Slimming API slims faces naturally in portraits while preserving facial identity, expression, and image quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"slim_degree": {
"type": "string",
"description": "Standard strength. The higher the value, the more pronounced the face slimming effect."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/face-beauty": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Face Beauty",
"description": "Face Beauty API retouches portraits with skin smoothing, whitening, face slimming, feature adjustment, acne removal, and makeup effects.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"sharp": {
"type": "string",
"description": "The degree of sharpening (sharpness). shu zhi The higher the degree of sharpening. The higher the degree of sharpening."
},
"smooth": {
"type": "string",
"description": "Smoothness. The higher the value, the higher the degree of smoothness."
},
"white": {
"type": "string",
"description": "Whitening degree. The higher the value, the higher the degree of whitening."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/face-beauty-advanced": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Face Beauty Advanced",
"description": "Face Beauty Advanced API smooths skin, brightens tone, removes acne, enlarges eyes, and beautifies up to five faces.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"whitening": {
"type": "string",
"description": "Whitening level: `0` means no whitening, `100` represents the highest level."
},
"smoothing": {
"type": "string",
"description": "Skin smoothing level: `0` means no skin smoothing, `100` represents the highest level."
},
"face_lifting": {
"type": "string",
"description": "Face slimming level: `0` means no face slimming, `100` represents the highest level."
},
"eye_enlarging": {
"type": "string",
"description": "Eye enlargement level: `0` means no eye enlargement, `100` represents the highest level."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result_image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/face-beauty-pro": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Face Beauty Pro",
"description": "Face Beauty Pro API provides advanced portrait retouching, face shaping, eyebrow removal, filters, and skin beautification.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `sync`: Synchronous tasks. `async`: Asynchronous tasks.",
"example": "sync"
},
"image": {
"type": "string",
"format": "binary"
},
"whitening": {
"type": "integer",
"description": "Whitening Degree. `0` means no whitening effect, `100` represents the highest degree.",
"example": "50"
},
"smoothing": {
"type": "integer",
"description": "Smoothing Degree. `0` means no smoothing effect, `100` represents the highest degree.",
"example": "50"
},
"thinface": {
"type": "integer",
"description": "Face Slimming Degree. `0` means no face slimming effect, `100` represents the highest degree.",
"example": "50"
},
"shrink_face": {
"type": "integer",
"description": "Small Face Degree. `0` means no small face effect, `100` represents the highest degree.",
"example": "50"
},
"enlarge_eye": {
"type": "integer",
"description": "Big Eyes Degree. `0` means no big eyes effect, `100` represents the highest degree.",
"example": "50"
},
"remove_eyebrow": {
"type": "integer",
"description": "Eyebrow Removal Degree. `0` means no eyebrow removal effect, `100` represents the highest degree.",
"example": "50"
},
"filter_type": {
"type": "string",
"description": "Filter Effects. `1`: Black and White. `2`: Calm. `3`: Sunny Day. `4`: Journey. `5`: Beautify Skin. `6`: Hong Kong Style. `7`: Aesthetic. `8`: Lovely. `9`: New York. `10`: Sakura. `11`: Seventeen. `12`: Soft Light. `13`: Afternoon Tea. `14`: Brighten Skin. `15`: Chaplin. `16`: Floral. `17`: Memories. `18`: Ice Beauty. `19`: Paris. `20`: Time. `21`: LOMO. `22`: Old Times. `23`: Early Spring. `24`: Story. `25`: Abao Color. `26`: Fill Light. `27`: Warm. `28`: Gorgeous. `29`: Lavender. `30`: Chanel. `31`: Prague. `32`: Old Dreams. `33`: Peach Blossom. `34`: Pink. `35`: Misty Rain."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "Sync",
"value": {
"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": ""
}
},
"example-1": {
"summary": "Async",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/face-filter": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Face Filters",
"description": "Face Filters API applies AI photo filters and special effects to transform image style with adjustable filter intensity.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"resource_type": {
"type": "string",
"description": "Picture style."
},
"strength": {
"type": "string",
"description": "Filter intensity."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/emotion-editor": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Change Facial Expressions",
"description": "Change Facial Expressions API edits portrait expressions with realistic smiles, cool looks, sad faces, and more while preserving identity.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image_target": {
"type": "string",
"format": "binary",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px."
},
"service_choice": {
"type": "string",
"enum": [
10,
11,
12,
13,
14,
15,
16,
100
],
"description": "Expression. See [Supported expression values](/docs/ai-portrait/effects/emotion-editor/api#expression)."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The content of the result data returned.",
"properties": {
"image": {
"type": "string",
"description": "The result image, returning the Base64 encoding of the image."
}
}
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"data": {
"image": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/emotion-editor-advanced": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Change Facial Expressions Advanced",
"description": "Change Facial Expressions Advanced API applies 100+ realistic expression styles to portraits while preserving facial identity and quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"expression"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"expression": {
"type": "string",
"description": "Expression. See [Supported expression values](/docs/ai-portrait/effects/emotion-editor-advanced/api#expression).",
"enum": [
"natural_smile",
"bright_laugh",
"sweet_smile",
"happy_surprise",
"proud_smirk",
"laughing_with_tears",
"crazy_happy_face",
"overjoyed_screaming_laugh",
"slight_annoyance",
"angry_stare",
"gritted_teeth_anger",
"furious_shout",
"cold_glare",
"cartoon_rage_face",
"angry_puffed_cheeks",
"villain_angry_smirk",
"downcast_sadness",
"wronged_near_tears",
"tearful_sadness",
"heartbroken_breakdown",
"silent_grief",
"big_crying_face",
"puppy_eyes_sad",
"fake_crying_funny",
"tongue_out_playful",
"wink_cute",
"silly_face",
"mischievous_smirk",
"exaggerated_surprised_face",
"cross_eyed_silly_face",
"one_eye_squint_funny",
"duck_face_funny",
"crazy_tongue_face",
"slight_surprise",
"shocked_open_mouth",
"disbelief",
"fearful_surprise",
"jaw_drop_surprise",
"cartoon_shocked_face",
"speechless_shock",
"nervous_fear",
"terrified_expression",
"timid_withdrawal",
"panic_breakdown",
"screaming_fear_face",
"frozen_in_fear",
"panic_wide_eyes",
"mild_dislike",
"strong_aversion",
"nauseated_disgust",
"eye_roll_disgust",
"extreme_disgust_face",
"grossed_out_face",
"dramatic_eye_roll",
"shy_smile",
"blushing_shyness",
"awkward_forced_smile",
"socially_embarrassed",
"over_shy_blushing_face",
"awkward_sweat_smile",
"embarrassed_cover_mouth",
"confident_smile",
"dominant_gaze",
"cold_cool_expression",
"victorious_pride",
"super_confident_smirk",
"bossy_cool_face",
"winning_smug_face",
"slight_confusion",
"frowning_thought",
"not_understanding",
"suspicious_look",
"confused_tilted_face",
"what_are_you_doing_face",
"brain_loading_face",
"tired_blank_eyes",
"helpless_expression",
"awkward_silence",
"sleepy_yawn",
"dead_inside_face",
"exhausted_melting_face",
"speechless_blank_stare",
"charming_smile",
"flirty_eyebrow_raise",
"soft_lip_bite",
"dreamy_gaze",
"playful_seductive_smirk",
"wink_flirty_face",
"dramatic_lip_bite",
"gentle_gaze",
"fond_smile",
"sweet_pouting_affection",
"deep_affectionate_gaze",
"heart_eyes_expression",
"overly_sweet_affection",
"clingy_cute_pout",
"cold_contempt",
"sarcastic_sneer",
"dismissive_pout",
"in_control_expression",
"extreme_smug_face",
"mocking_laugh_face",
"looking_down_contempt",
"soft_cute_smile",
"cute_pout",
"innocent_big_eyes",
"expectant_sparkling_eyes",
"super_cute_pouting_face",
"sparkling_eyes_cute",
"baby_like_innocent_face",
"frowning_in_pain",
"holding_back_tears",
"crying_breakdown",
"repressed_exhaustion",
"dramatic_pain_face",
"holding_back_scream",
"overwhelmed_breakdown_face"
]
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/hairstyle-editor-pro": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Hairstyle Changer Pro",
"description": "Hairstyle Changer Pro API generates a single AI hairstyle and hair color preview from a portrait photo.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"hair_style"
],
"properties": {
"image": {
"type": "string",
"description": "Source image. \n- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Larger than 200x200px, smaller than 4090x4090px. \n- Minimum Face Proportion: To ensure effectiveness, the proportion of the face in the image cannot be less than 10%. \n- Facial Integrity: To ensure effectiveness, the face in the image should ideally not be obscured. \n- Facial Angle: To ensure effectiveness, the face in the image should ideally be front-facing, with no more than a 30-degree rotation to the left or right.",
"format": "binary"
},
"hair_style": {
"type": "string",
"description": "Hairstyle. See [Supported hair_style values](/docs/ai-portrait/effects/hairstyle-editor-pro/api#hair_style).",
"enum": [
"BuzzCut",
"UnderCut",
"Pompadour",
"SlickBack",
"CurlyShag",
"WavyShag",
"FauxHawk",
"Spiky",
"CombOver",
"HighTightFade",
"ManBun",
"Afro",
"LowFade",
"UndercutLongHair",
"TwoBlockHaircut",
"TexturedFringe",
"BluntBowlCut",
"LongWavyCurtainBangs",
"MessyTousled",
"CornrowBraids",
"LongHairTiedUp",
"Middle-parted",
"ManGreased",
"WavyMiddlePart",
"Natural_Side-Part",
"Wolf_Crop",
"Wind-Tousled_Crop",
"Side-Parted_Textured",
"FluffyMiddlePart",
"FreshSide-Parted",
"Smooth_Crop",
"Korean_Wavy_Crop",
"Comma_Hair",
"Side-Part_Crop",
"Natural_Middle_Part",
"ShortPixieWithShavedSides",
"ShortNeatBob",
"DoubleBun",
"Updo",
"Spiked",
"bowlCut",
"Chignon",
"PixieCut",
"SlickedBack",
"LongCurly",
"CurlyBob",
"StackedCurlsInShortBob",
"SidePartCombOverHairstyleWithHighFade",
"WavyFrenchBobVibesfrom1920",
"BobCut",
"ShortTwintails",
"ShortCurlyPixie",
"LongStraight",
"LongWavy",
"FishtailBraid",
"TwinBraids",
"Ponytail",
"Dreadlocks",
"Cornrows",
"ShoulderLengthHair",
"LooseCurlyAfro",
"LongTwintails",
"LongHimeCut",
"BoxBraids",
"Layered_Waves",
"Side_Flip_Perm",
"Textured_Crop",
"Mushroom_Curl",
"Vintage_Curls",
"Magic_Perm",
"Side-Parted_Waves",
"Fluffy_Short",
"Smooth_Inward_Bob",
"Neat_Short",
"Natural_Short",
"Chic_Tapered_Bob",
"Edgy_Textured_Pixie",
"Elegant_Wavy_Crop",
"Chic_Wavy_Pixie",
"Elegant_Side_Wave",
"Soft_Layered_Curl",
"Executive_Pixie",
"Curved_Chic_Bob",
"Airy_Short_Curls",
"Playful_Curly_Bob",
"Playful_Wavy_Bob",
"Elegant_Soft_Curl",
"Elegant_Smooth_Bob",
"Retro_Airy_Curl",
"Soft_Wavy_Bob",
"Light_Inward_Bob",
"Neat_Curly_Crop_Cut",
"Elegant_Volumized_Bob",
"Modern_Curls_Chic",
"Mocha_Volume_Pixie",
"Elegant_Side_Flow",
"Chestnut",
"ChoppyBangs",
"StructuredWavyShag",
"TinfoilPerm",
"ClassicWavyBob",
"Fluffy_Pixie_Cut",
"FrenchBangs",
"JapaneseShort",
"MediumLongLayered",
"male_hairstyle_0001",
"male_hairstyle_0002",
"male_hairstyle_0003",
"male_hairstyle_0004",
"male_hairstyle_0005",
"male_hairstyle_0006",
"male_hairstyle_0007",
"male_hairstyle_0008",
"male_hairstyle_0009",
"male_hairstyle_0010",
"male_hairstyle_0011",
"male_hairstyle_0012",
"male_hairstyle_0013",
"male_hairstyle_0014",
"male_hairstyle_0015",
"male_hairstyle_0016",
"male_hairstyle_0017",
"male_hairstyle_0018",
"male_hairstyle_0019",
"male_hairstyle_0020",
"male_hairstyle_0021",
"male_hairstyle_0022",
"male_hairstyle_0023",
"male_hairstyle_0024",
"male_hairstyle_0025",
"male_hairstyle_0026",
"male_hairstyle_0027",
"male_hairstyle_0028",
"male_hairstyle_0029",
"male_hairstyle_0030",
"male_hairstyle_0031",
"male_hairstyle_0032",
"male_hairstyle_0033",
"male_hairstyle_0034",
"male_hairstyle_0035",
"male_hairstyle_0036",
"male_hairstyle_0037",
"male_hairstyle_0038",
"male_hairstyle_0039",
"male_hairstyle_0040",
"male_hairstyle_0041",
"male_hairstyle_0042",
"male_hairstyle_0043",
"male_hairstyle_0044",
"male_hairstyle_0045",
"male_hairstyle_0046",
"male_hairstyle_0047",
"male_hairstyle_0048",
"male_hairstyle_0049",
"male_hairstyle_0050",
"male_hairstyle_0051",
"male_hairstyle_0052",
"male_hairstyle_0053",
"male_hairstyle_0054",
"male_hairstyle_0055",
"male_hairstyle_0056",
"male_hairstyle_0057",
"male_hairstyle_0058",
"male_hairstyle_0059",
"male_hairstyle_0060",
"male_hairstyle_0061",
"male_hairstyle_0062",
"female_hairstyle_0001",
"female_hairstyle_0002",
"female_hairstyle_0003",
"female_hairstyle_0004",
"female_hairstyle_0005",
"female_hairstyle_0006",
"female_hairstyle_0007",
"female_hairstyle_0008",
"female_hairstyle_0009",
"female_hairstyle_0010",
"female_hairstyle_0011",
"female_hairstyle_0012",
"female_hairstyle_0013",
"female_hairstyle_0014",
"female_hairstyle_0015",
"female_hairstyle_0016",
"female_hairstyle_0017",
"female_hairstyle_0018",
"female_hairstyle_0019",
"female_hairstyle_0020",
"female_hairstyle_0021",
"female_hairstyle_0022",
"female_hairstyle_0023",
"female_hairstyle_0024",
"female_hairstyle_0025",
"female_hairstyle_0026",
"female_hairstyle_0027",
"female_hairstyle_0028",
"female_hairstyle_0029",
"female_hairstyle_0030",
"female_hairstyle_0031",
"female_hairstyle_0032",
"female_hairstyle_0033",
"female_hairstyle_0034",
"female_hairstyle_0035",
"female_hairstyle_0036",
"female_hairstyle_0037",
"female_hairstyle_0038",
"female_hairstyle_0039",
"female_hairstyle_0040",
"female_hairstyle_0041",
"female_hairstyle_0042",
"female_hairstyle_0043",
"female_hairstyle_0044",
"female_hairstyle_0045",
"female_hairstyle_0046",
"female_hairstyle_0047",
"female_hairstyle_0048",
"female_hairstyle_0049",
"female_hairstyle_0050",
"female_hairstyle_0051",
"female_hairstyle_0052",
"female_hairstyle_0053",
"female_hairstyle_0054",
"female_hairstyle_0055",
"female_hairstyle_0056",
"female_hairstyle_0057",
"female_hairstyle_0058",
"female_hairstyle_0059",
"female_hairstyle_0060",
"female_hairstyle_0061",
"female_hairstyle_0062",
"female_hairstyle_0063",
"female_hairstyle_0064",
"female_hairstyle_0065",
"female_hairstyle_0066",
"female_hairstyle_0067",
"female_hairstyle_0068",
"female_hairstyle_0069",
"female_hairstyle_0070",
"female_hairstyle_0071",
"female_hairstyle_0072",
"female_hairstyle_0073"
],
"example": "BuzzCut"
},
"color": {
"type": "string",
"description": "Hair color preset. See [Supported color values](/docs/ai-portrait/effects/hairstyle-editor-pro/api#color).",
"enum": [
"blonde",
"platinumBlonde",
"brown",
"lightBrown",
"blue",
"lightBlue",
"purple",
"lightPurple",
"pink",
"black",
"white",
"grey",
"silver",
"red",
"orange",
"green",
"gradient",
"multicolored",
"darkBlue",
"burgundy",
"darkGreen"
],
"default": "blonde"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/hairstyle-editor-premium": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Hairstyle Changer Premium",
"description": "Hairstyle Changer Premium API generates preset or reference-based hairstyles and custom hair colors for men and women.",
"requestBody": {
"description": "Provide `hair_style` or `image_template`. If both are provided, `hair_style` takes precedence.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"anyOf": [
{
"required": [
"hair_style"
]
},
{
"required": [
"image_template"
]
}
],
"properties": {
"image": {
"type": "string",
"description": "Source image. \n- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Larger than 200x200px, smaller than 4090x4090px. \n- Minimum Face Proportion: To ensure effectiveness, the proportion of the face in the image cannot be less than 10%. \n- Facial Integrity: To ensure effectiveness, the face in the image should ideally not be obscured. \n- Facial Angle: To ensure effectiveness, the face in the image should ideally be front-facing, with no more than a 30-degree rotation to the left or right.",
"format": "binary"
},
"image_template": {
"type": "string",
"description": "Reference image for hairstyle transfer. Provide this field or `hair_style`. If both are provided, `image_template` is ignored. \n- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Larger than 200x200px, smaller than 4090x4090px. \n- Minimum Face Proportion: To ensure effectiveness, the proportion of the face in the image cannot be less than 10%. \n- Facial Integrity: To ensure effectiveness, the face in the image should ideally not be obscured. \n- Facial Angle: To ensure effectiveness, the face in the image should ideally be front-facing, with no more than a 30-degree rotation to the left or right.",
"format": "binary"
},
"hair_style": {
"type": "string",
"description": "Built-in hairstyle preset. Provide this field or `image_template`. If both are provided, `hair_style` takes precedence. See [Supported hair_style values](/docs/ai-portrait/effects/hairstyle-editor-premium/api#hair_style).",
"enum": [
"BuzzCut",
"UnderCut",
"Pompadour",
"SlickBack",
"CurlyShag",
"WavyShag",
"FauxHawk",
"Spiky",
"CombOver",
"HighTightFade",
"ManBun",
"Afro",
"LowFade",
"UndercutLongHair",
"TwoBlockHaircut",
"TexturedFringe",
"BluntBowlCut",
"LongWavyCurtainBangs",
"MessyTousled",
"CornrowBraids",
"LongHairTiedUp",
"Middle-parted",
"ManGreased",
"WavyMiddlePart",
"Natural_Side-Part",
"Wolf_Crop",
"Wind-Tousled_Crop",
"Side-Parted_Textured",
"FluffyMiddlePart",
"FreshSide-Parted",
"Smooth_Crop",
"Korean_Wavy_Crop",
"Comma_Hair",
"Side-Part_Crop",
"Natural_Middle_Part",
"ShortPixieWithShavedSides",
"ShortNeatBob",
"DoubleBun",
"Updo",
"Spiked",
"bowlCut",
"Chignon",
"PixieCut",
"SlickedBack",
"LongCurly",
"CurlyBob",
"StackedCurlsInShortBob",
"SidePartCombOverHairstyleWithHighFade",
"WavyFrenchBobVibesfrom1920",
"BobCut",
"ShortTwintails",
"ShortCurlyPixie",
"LongStraight",
"LongWavy",
"FishtailBraid",
"TwinBraids",
"Ponytail",
"Dreadlocks",
"Cornrows",
"ShoulderLengthHair",
"LooseCurlyAfro",
"LongTwintails",
"LongHimeCut",
"BoxBraids",
"Layered_Waves",
"Side_Flip_Perm",
"Textured_Crop",
"Mushroom_Curl",
"Vintage_Curls",
"Magic_Perm",
"Side-Parted_Waves",
"Fluffy_Short",
"Smooth_Inward_Bob",
"Neat_Short",
"Natural_Short",
"Chic_Tapered_Bob",
"Edgy_Textured_Pixie",
"Elegant_Wavy_Crop",
"Chic_Wavy_Pixie",
"Elegant_Side_Wave",
"Soft_Layered_Curl",
"Executive_Pixie",
"Curved_Chic_Bob",
"Airy_Short_Curls",
"Playful_Curly_Bob",
"Playful_Wavy_Bob",
"Elegant_Soft_Curl",
"Elegant_Smooth_Bob",
"Retro_Airy_Curl",
"Soft_Wavy_Bob",
"Light_Inward_Bob",
"Neat_Curly_Crop_Cut",
"Elegant_Volumized_Bob",
"Modern_Curls_Chic",
"Mocha_Volume_Pixie",
"Elegant_Side_Flow",
"Chestnut",
"ChoppyBangs",
"StructuredWavyShag",
"TinfoilPerm",
"ClassicWavyBob",
"Fluffy_Pixie_Cut",
"FrenchBangs",
"JapaneseShort",
"MediumLongLayered",
"male_hairstyle_0001",
"male_hairstyle_0002",
"male_hairstyle_0003",
"male_hairstyle_0004",
"male_hairstyle_0005",
"male_hairstyle_0006",
"male_hairstyle_0007",
"male_hairstyle_0008",
"male_hairstyle_0009",
"male_hairstyle_0010",
"male_hairstyle_0011",
"male_hairstyle_0012",
"male_hairstyle_0013",
"male_hairstyle_0014",
"male_hairstyle_0015",
"male_hairstyle_0016",
"male_hairstyle_0017",
"male_hairstyle_0018",
"male_hairstyle_0019",
"male_hairstyle_0020",
"male_hairstyle_0021",
"male_hairstyle_0022",
"male_hairstyle_0023",
"male_hairstyle_0024",
"male_hairstyle_0025",
"male_hairstyle_0026",
"male_hairstyle_0027",
"male_hairstyle_0028",
"male_hairstyle_0029",
"male_hairstyle_0030",
"male_hairstyle_0031",
"male_hairstyle_0032",
"male_hairstyle_0033",
"male_hairstyle_0034",
"male_hairstyle_0035",
"male_hairstyle_0036",
"male_hairstyle_0037",
"male_hairstyle_0038",
"male_hairstyle_0039",
"male_hairstyle_0040",
"male_hairstyle_0041",
"male_hairstyle_0042",
"male_hairstyle_0043",
"male_hairstyle_0044",
"male_hairstyle_0045",
"male_hairstyle_0046",
"male_hairstyle_0047",
"male_hairstyle_0048",
"male_hairstyle_0049",
"male_hairstyle_0050",
"male_hairstyle_0051",
"male_hairstyle_0052",
"male_hairstyle_0053",
"male_hairstyle_0054",
"male_hairstyle_0055",
"male_hairstyle_0056",
"male_hairstyle_0057",
"male_hairstyle_0058",
"male_hairstyle_0059",
"male_hairstyle_0060",
"male_hairstyle_0061",
"male_hairstyle_0062",
"female_hairstyle_0001",
"female_hairstyle_0002",
"female_hairstyle_0003",
"female_hairstyle_0004",
"female_hairstyle_0005",
"female_hairstyle_0006",
"female_hairstyle_0007",
"female_hairstyle_0008",
"female_hairstyle_0009",
"female_hairstyle_0010",
"female_hairstyle_0011",
"female_hairstyle_0012",
"female_hairstyle_0013",
"female_hairstyle_0014",
"female_hairstyle_0015",
"female_hairstyle_0016",
"female_hairstyle_0017",
"female_hairstyle_0018",
"female_hairstyle_0019",
"female_hairstyle_0020",
"female_hairstyle_0021",
"female_hairstyle_0022",
"female_hairstyle_0023",
"female_hairstyle_0024",
"female_hairstyle_0025",
"female_hairstyle_0026",
"female_hairstyle_0027",
"female_hairstyle_0028",
"female_hairstyle_0029",
"female_hairstyle_0030",
"female_hairstyle_0031",
"female_hairstyle_0032",
"female_hairstyle_0033",
"female_hairstyle_0034",
"female_hairstyle_0035",
"female_hairstyle_0036",
"female_hairstyle_0037",
"female_hairstyle_0038",
"female_hairstyle_0039",
"female_hairstyle_0040",
"female_hairstyle_0041",
"female_hairstyle_0042",
"female_hairstyle_0043",
"female_hairstyle_0044",
"female_hairstyle_0045",
"female_hairstyle_0046",
"female_hairstyle_0047",
"female_hairstyle_0048",
"female_hairstyle_0049",
"female_hairstyle_0050",
"female_hairstyle_0051",
"female_hairstyle_0052",
"female_hairstyle_0053",
"female_hairstyle_0054",
"female_hairstyle_0055",
"female_hairstyle_0056",
"female_hairstyle_0057",
"female_hairstyle_0058",
"female_hairstyle_0059",
"female_hairstyle_0060",
"female_hairstyle_0061",
"female_hairstyle_0062",
"female_hairstyle_0063",
"female_hairstyle_0064",
"female_hairstyle_0065",
"female_hairstyle_0066",
"female_hairstyle_0067",
"female_hairstyle_0068",
"female_hairstyle_0069",
"female_hairstyle_0070",
"female_hairstyle_0071",
"female_hairstyle_0072",
"female_hairstyle_0073"
],
"example": "BuzzCut"
},
"color": {
"type": "string",
"description": "Hair color preset. `original` keeps the source image color. `reference` uses the hair color from `image_template`. See [Supported color values](/docs/ai-portrait/effects/hairstyle-editor-premium/api#color).",
"enum": [
"original",
"reference",
"blonde",
"platinumBlonde",
"brown",
"lightBrown",
"blue",
"lightBlue",
"purple",
"lightPurple",
"pink",
"black",
"white",
"grey",
"silver",
"red",
"orange",
"green",
"gradient",
"multicolored",
"darkBlue",
"burgundy",
"darkGreen"
],
"default": "original"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/blurred-faces": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Face Blur",
"description": "Face Blur API automatically detects and blurs faces in images to protect privacy while preserving overall image quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/face-attribute-editing": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Age & Gender swap",
"description": "Age & Gender Swap API edits portrait attributes to change age or gender and generate realistic face transformation effects.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"action_type": {
"type": "string",
"description": "Face editing method. `TO_KID`: V1 version becomes a child. `TO_OLD`: V1 version becomes old man. `TO_FEMALE`: V1 version becomes girls. `TO_MALE`: V1 version becomes boys. `V2_AGE`: V2 version age change. `V2_GENDER`: v2 version gender shift."
},
"quality_control": {
"type": "string",
"description": "Image quality (`image` field image quality).
Please select the appropriate option based on quality information such as masking, lighting, blurriness, and integrity of the face.
If selecting a higher quality causes the image to be unprocessable, please select a lower quality to try. `NONE`: No control is performed. `LOW`: Lower quality requirements. `NORMAL`: General quality requirements. `HIGH`: Higher quality requirements."
},
"face_location": {
"type": "string",
"description": "When multiple faces are detected in the image, use this parameter to specify the position of the face to be edited in the image, or default to the largest face in the image if not specified."
},
"target": {
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "TO_KID|TO_OLD|TO_FEMALE|TO_MALE",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"image": ""
}
}
},
"example-1": {
"summary": "V2_AGE",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"image": ""
}
}
},
"example-2": {
"summary": "V2_GENDER",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"image": ""
}
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/enhance-face": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Face Enhancer",
"description": "AI Face Enhancer API improves face clarity, restores details, and enhances blurry portrait images with face-driven AI.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/lips-color-changer": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "Lips Color Changer",
"description": "Lips Color Changer API applies realistic virtual lipstick colors to portraits using facial recognition and precise lip detection.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"lip_color_infos": {
"type": "string",
"description": "Lip Color Info. You can enter up to 3 lip_color_info to enable changing the lip color for up to 3 faces in a graph."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result_image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/ai-square-face-filter": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Square Face Filter",
"description": "AI Square Face Filter API turns portraits into rounded-square cartoon avatars while preserving identity and facial features.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/ai-big-head-effect": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Big Head Effect",
"description": "AI Big Head Effect API creates big-head portrait effects while preserving identity, hairstyle, outfit, background, and lighting.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/ai-red-lip-gloss": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Red Lip Gloss",
"description": "AI Red Lip Gloss API adds glossy red lips to portraits while preserving facial features, expression, skin tone, and natural lighting.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/ai-lip-bite-expressions": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Lip Bite Expressions",
"description": "AI Lip Bite Expressions API turns portraits into consistent lip bite emoji packs with 1, 4, 6, or 9 panels.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"grid_count": {
"type": "integer",
"description": "Specifies the number of emoji stickers to generate in a single image.",
"enum": [
1,
4,
6,
9
],
"default": 1
},
"aspect_ratio": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"auto",
"1:1",
"3:4",
"4:3",
"9:16",
"16:9"
],
"default": "auto"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/effects/ai-halloween-mask": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Effects"
],
"summary": "AI Halloween Mask",
"description": "AI Halloween Mask API adds spooky Halloween masks to portraits while preserving identity, lighting, background, and facial structure.",
"requestBody": {
"description": "Provide `mask_style` or `image_template`. If both are provided, `mask_style` takes precedence.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"anyOf": [
{
"required": [
"mask_style"
]
},
{
"required": [
"image_template"
]
}
],
"properties": {
"image": {
"type": "string",
"description": "Source image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"mask_style": {
"type": "string",
"description": "Built-in mask preset. Provide either this field or `image_template`. If both are provided, `mask_style` takes precedence. See [Supported mask styles](/docs/ai-portrait/effects/ai-halloween-mask/api#mask_style).",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85
]
},
"image_template": {
"type": "string",
"description": "Reference image for eyeshadow transfer. Provide this field or `mask_style`. If both are provided, `image_template` is ignored. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"aspect_ratio": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"auto",
"1:1",
"3:4",
"4:3",
"9:16",
"16:9"
],
"default": "auto"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-big-tits": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Breast Expansion",
"description": "AI Breast Expansion API enlarges the bust area in portraits while preserving face, clothing, background, and body proportions.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `async`: Asynchronous tasks.",
"example": "async"
},
"person_image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"image": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/try-on-clothes": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "Try on Clothes",
"description": "Try on Clothes API generates virtual clothing try-on images from person and garment photos for fashion apps and e-commerce.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `async`: Asynchronous tasks.",
"example": "async"
},
"person_image": {
"type": "string",
"description": "Portrait image.",
"format": "binary"
},
"clothes_image": {
"type": "string",
"description": "Clothing image.",
"format": "binary"
},
"clothes_type": {
"type": "string",
"description": "Clothing Types. `upper_body`: Upper body clothing. `lower_body`: Lower body clothing. `full_body`: Full body clothing."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/try-on-clothes-pro": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "Try on Clothes Pro",
"description": "Try on Clothes Pro API creates realistic virtual try-on images from flat clothing and full-body portraits for fashion previews.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `async`: Asynchronous tasks.",
"example": "async"
},
"person_image": {
"type": "string",
"description": "Portrait image.",
"format": "binary"
},
"top_garment": {
"type": "string",
"description": "Upper Body Clothing Image.",
"format": "binary"
},
"resolution": {
"type": "number",
"description": "Output Image Resolution. If you need to call **[Try on Clothes Refiner](https://documenter.getpostman.com/view/26387069/2s93JxqgHE#75de8e09-37dd-4b31-b4f8-33a666cebb2a)** in the future, select `-1`. `-1`: Original image resolution. `1024`: 576x1024px. `1280`: 720x1280px.",
"example": "-1"
},
"restore_face": {
"type": "boolean",
"description": "Whether to Keep the Model’s Face. If you need to call **[Try on Clothes Refiner](https://documenter.getpostman.com/view/26387069/2s93JxqgHE#75de8e09-37dd-4b31-b4f8-33a666cebb2a)** in the future, select `true`. `true`: Keep the model’s original face. `false`: Regenerate the model’s face.",
"example": "true"
},
"bottom_garment": {
"type": "string",
"description": "Lower Body Clothing Image. If no lower body clothing image is provided, the lower body clothing effect will be randomly generated. If lower body clothing is not needed (e.g., when the upper body garment is a dress), this value should be left empty.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/try-on-clothes-premium": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "Try on Clothes Premium",
"description": "Try on Clothes Premium API creates high-quality virtual try-on images with realistic garment fit, texture, and body alignment.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `async`: Asynchronous tasks.",
"example": "async"
},
"person_image": {
"type": "string",
"description": "Portrait image.",
"format": "binary"
},
"top_garment": {
"type": "string",
"description": "Upper Body Clothing Image.",
"format": "binary"
},
"resolution": {
"type": "number",
"description": "Output Image Resolution. If you need to call **[Try on Clothes Refiner](https://documenter.getpostman.com/view/26387069/2s93JxqgHE#75de8e09-37dd-4b31-b4f8-33a666cebb2a)** in the future, select `-1`. `-1`: Original image resolution. `1024`: 576x1024px. `1280`: 720x1280px.",
"example": "-1"
},
"restore_face": {
"type": "boolean",
"description": "Whether to Keep the Model’s Face. If you need to call **[Try on Clothes Refiner](https://documenter.getpostman.com/view/26387069/2s93JxqgHE#75de8e09-37dd-4b31-b4f8-33a666cebb2a)** in the future, select `true`. `true`: Keep the model’s original face. `false`: Regenerate the model’s face.",
"example": "true"
},
"bottom_garment": {
"type": "string",
"description": "Lower Body Clothing Image. If no lower body clothing image is provided, the lower body clothing effect will be randomly generated. If lower body clothing is not needed (e.g., when the upper body garment is a dress), this value should be left empty.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-face-swap": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Face Swap",
"description": "AI Face Swap API swaps a source face onto a target image and returns an asynchronous task ID for result retrieval.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image_target",
"image_template"
],
"properties": {
"image_target": {
"type": "string",
"description": "The image to be modified. The face in this image will be replaced. \n- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"image_template": {
"type": "string",
"description": "The image that provides the face to use. \n- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-colored-contacts": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Colored Contacts",
"description": "AI Colored Contacts API applies realistic colored contact lens effects to portraits using prompt-guided eye color customization.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"name": {
"type": "string",
"description": "Contact Lens Name (English only).",
"maxLength": 500
},
"desc": {
"type": "string",
"description": "Contact Lens Description (English only).",
"maxLength": 1000
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-eyelashes": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Eyelashes",
"description": "AI Eyelashes API applies natural-looking eyelash effects to portraits using prompt-guided eye style enhancement.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"name": {
"type": "string",
"description": "Eyelash Name (English only).",
"maxLength": 500
},
"desc": {
"type": "string",
"description": "Eyelash Description (English only).",
"maxLength": 1000
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-eyebrows": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Eyebrows",
"description": "AI Eyebrows API applies reference-guided eyebrow styles to portraits with realistic shape, detail, and high-resolution output.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"reference_image"
],
"properties": {
"image": {
"type": "string",
"description": "Source image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"reference_image": {
"type": "string",
"description": "Reference Image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"resolution": {
"type": "string",
"description": "Resolution.",
"enum": [
"1K",
"2K"
],
"default": "1K"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-hair-color": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Hair Color",
"description": "AI Hair Color API applies realistic hair color effects to portraits with prompt-guided tones, styles, and natural results.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"name": {
"type": "string",
"description": "Hair Color Name (English only).",
"maxLength": 500
},
"desc": {
"type": "string",
"description": "Hair Color Description (English only).",
"maxLength": 1000
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-beard-removal": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Beard Removal",
"description": "AI Beard Removal API removes beards, mustaches, and facial hair from portraits to create realistic clean-shaven results.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-hair-loss-simulation": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Hair Loss Simulation",
"description": "AI Hair Loss Simulation API creates realistic hair thinning, receding hairline, and baldness previews from portrait photos.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"level"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"level": {
"type": "string",
"description": "Hair loss level. See [Supported level values](/docs/ai-portrait/editing/ai-hair-loss-simulation/api#level).",
"enum": [
"man_1",
"man_2",
"man_3",
"man_4",
"man_5",
"man_6",
"man_7",
"woman_1",
"woman_2",
"woman_3",
"woman_4",
"woman_5",
"woman_6",
"woman_7"
]
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-beard-styling": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Beard Styling",
"description": "AI Beard Styling API adds realistic beard and mustache styles to portraits for grooming apps, barbershop tools, and virtual try-ons.",
"requestBody": {
"description": "Provide `beard` or `image_template`. If both are provided, `beard` takes precedence.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"anyOf": [
{
"required": [
"beard"
]
},
{
"required": [
"image_template"
]
}
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"beard": {
"type": "string",
"description": "Built-in beard preset. Provide this field or `image_template`. If both are provided, `beard` takes precedence. See [Supported beard values](/docs/ai-portrait/editing/ai-beard-styling/api#beard).",
"enum": [
"FullBeardClassic",
"CorporateBeard",
"Garibaldi",
"Verdi",
"FullBeardTapered",
"VanDyke",
"Bandholz",
"VanDykeRefined",
"Goatee",
"ExtendedGoatee",
"Balbo",
"AnchorBeardClean",
"DucktailBeardPointed",
"AnchorBeardFull",
"DucktailBeardFull",
"HeavyStubble",
"ChevronMoustache",
"HandlebarMoustache",
"ImperialMoustache",
"CircleBeard",
"ChinStrap",
"MuttonChops",
"SoulPatch",
"PetiteGoatee"
]
},
"image_template": {
"type": "string",
"description": "Reference image for beard transfer. Provide this field or `beard`. If both are provided, `image_template` is ignored. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-bald": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Bald",
"description": "AI Bald API creates realistic bald head and hair loss previews from portraits for hairstyle apps and virtual makeover tools.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-butt-enhancement": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Butt Enhancement",
"description": "AI Butt Enhancement API naturally enhances butt shape and curves while preserving body proportions, clothing, pose, and image quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-waist-slimming": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Waist Slimming",
"description": "AI Waist Slimming API creates a slimmer waist while preserving natural body proportions, clothing, pose, and image quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-lip-enhancement": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Lip Enhancement",
"description": "AI Lip Enhancement API creates fuller, natural-looking lips while preserving facial features, expression, skin tone, and image quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-fat-filter": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Fat Filter",
"description": "AI Fat Filter API makes people look naturally heavier while preserving identity, facial features, clothing, pose, and background.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` \n- Image size: No more than 5 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/editing/ai-eyeshadow": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Editing"
],
"summary": "AI Eyeshadow Try-On",
"description": "AI Eyeshadow Try-On API applies realistic eyeshadow styles while preserving facial features, skin tone, expression, and lighting.",
"requestBody": {
"description": "Provide `eyeshadow_style` or `image_template`. If both are provided, `eyeshadow_style` takes precedence.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"anyOf": [
{
"required": [
"eyeshadow_style"
]
},
{
"required": [
"image_template"
]
}
],
"properties": {
"image": {
"type": "string",
"description": "Source image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"eyeshadow_style": {
"type": "string",
"description": "Built-in eyeshadow preset. Provide this field or `image_template`. If both are provided, `eyeshadow_style` takes precedence. See [Supported eyeshadow styles](/docs/ai-portrait/editing/ai-eyeshadow/api#eyeshadow_style).",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36
]
},
"image_template": {
"type": "string",
"description": "Reference image for eyeshadow transfer. Provide this field or `eyeshadow_style`. If both are provided, `image_template` is ignored. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"aspect_ratio": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"auto",
"1:1",
"3:4",
"4:3",
"9:16",
"16:9"
],
"default": "auto"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/enhance/try-on-clothes-refiner": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Enhance"
],
"summary": "Try on Clothes Refiner",
"description": "Try on Clothes Refiner API enhances virtual try-on images with more realistic details, colors, and clothing fit.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type. `async`: Asynchronous tasks.",
"example": "async"
},
"person_image": {
"type": "string",
"description": "Model image for calling the Try on Clothes API.",
"format": "binary"
},
"top_garment": {
"type": "string",
"description": "Top clothing image for calling the Try on Clothes API.",
"format": "binary"
},
"coarse_image": {
"type": "string",
"description": "Result image obtained from calling the Try on Clothes API.",
"format": "binary"
},
"gender": {
"type": "string",
"description": "Gender of the `person_image`. `woman`: Female. `man`: Male.",
"example": "man"
},
"bottom_garment": {
"type": "string",
"description": "Bottom clothing image for calling the Try on Clothes API.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/face-key-points": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "Facial Landmarks",
"description": "Facial Landmarks API detects 72, 150, or 201 face key points for facial contours, eyes, eyebrows, lips, and nose.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"max_face_num": {
"type": "string",
"description": "The maximum number of faces to process. The default value is 1 (only the face with the largest area in the image is detected)."
},
"face_field": {
"type": "string",
"description": "Returns more information about the face (by default only face_token, face frame, probability and rotation angle are returned). `age`: Age information. `gender`: Gender information. `landmark4`: 4 feature points. `landmark72`: 72 feature points. `landmark150`: 150 feature points. `landmark201`: 201 feature points."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "landmark4",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"face_num": "",
"face_list": [
{
"face_token": "",
"location": {
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"rotation": 0
}
}
],
"face_probability": 0,
"angle": [
{
"yaw": 0,
"pitch": 0,
"roll": 0
}
],
"age": 0,
"gender": [
{
"type": "",
"probability": 0
}
],
"landmark4": [
{
"x": 148.37,
"y": 100.59
},
{
"x": 234.82,
"y": 90.52
},
{
"x": 199.34,
"y": 135.81
},
{
"x": 203.17,
"y": 179.29
}
]
}
}
},
"example-1": {
"summary": "landmark72",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"face_num": "",
"face_list": [
{
"face_token": "",
"location": {
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"rotation": 0
}
}
],
"face_probability": 0,
"angle": [
{
"yaw": 0,
"pitch": 0,
"roll": 0
}
],
"age": 0,
"gender": [
{
"type": "",
"probability": 0
}
],
"landmark72": [
{
"x": 100.08,
"y": 122.9
},
{
"x": 106.77,
"y": 149.07
},
{
"x": 115.46,
"y": 174.85
},
{
"x": 127.3,
"y": 199.99
},
{
"x": 151.98,
"y": 222.51
},
{
"x": 181.8,
"y": 235.05
},
{
"x": 209.56,
"y": 236.15
},
{
"x": 235.09,
"y": 227.11
},
{
"x": 259.5,
"y": 205.96
},
{
"x": 274.62,
"y": 178.35
},
{
"x": 279.28,
"y": 151.9
},
{
"x": 280.94,
"y": 125.59
},
{
"x": 280.4,
"y": 99.89
},
{
"x": 128.11,
"y": 106.45
},
{
"x": 136.37,
"y": 97.92
},
{
"x": 146.18,
"y": 94.09
},
{
"x": 156.75,
"y": 95.54
},
{
"x": 167.29,
"y": 102.81
},
{
"x": 157.75,
"y": 105.5
},
{
"x": 147.51,
"y": 107.65
},
{
"x": 137.1,
"y": 108.02
},
{
"x": 148.37,
"y": 100.59
},
{
"x": 111.06,
"y": 88.35
},
{
"x": 120.9,
"y": 71.46
},
{
"x": 136.29,
"y": 64.57
},
{
"x": 152.5,
"y": 62.86
},
{
"x": 168.22,
"y": 70.9
},
{
"x": 153.23,
"y": 72.9
},
{
"x": 137.92,
"y": 74.23
},
{
"x": 123.75,
"y": 79.02
},
{
"x": 217.95,
"y": 97.14
},
{
"x": 226.23,
"y": 87.37
},
{
"x": 236.37,
"y": 83.63
},
{
"x": 246.55,
"y": 84.88
},
{
"x": 256.18,
"y": 91.67
},
{
"x": 248.15,
"y": 95.06
},
{
"x": 238.3,
"y": 97.02
},
{
"x": 227.85,
"y": 97.26
},
{
"x": 234.82,
"y": 90.52
},
{
"x": 210.71,
"y": 65.97
},
{
"x": 223.61,
"y": 54.58
},
{
"x": 238.8,
"y": 52.63
},
{
"x": 254.62,
"y": 55.99
},
{
"x": 266.84,
"y": 69.55
},
{
"x": 253.78,
"y": 63.55
},
{
"x": 239.71,
"y": 62.6
},
{
"x": 225.24,
"y": 64.54
},
{
"x": 181.11,
"y": 101.65
},
{
"x": 179.98,
"y": 117.06
},
{
"x": 178.41,
"y": 132.61
},
{
"x": 174.58,
"y": 150.84
},
{
"x": 187.7,
"y": 148.58
},
{
"x": 212.42,
"y": 145.66
},
{
"x": 223.67,
"y": 144.55
},
{
"x": 215.58,
"y": 127.75
},
{
"x": 210.32,
"y": 113.35
},
{
"x": 205.05,
"y": 98.7
},
{
"x": 199.34,
"y": 135.81
},
{
"x": 164.93,
"y": 181.13
},
{
"x": 183.01,
"y": 172.43
},
{
"x": 202.75,
"y": 169.17
},
{
"x": 221.78,
"y": 167.99
},
{
"x": 238.94,
"y": 172.43
},
{
"x": 224.92,
"y": 186.73
},
{
"x": 204.97,
"y": 193.61
},
{
"x": 183.27,
"y": 191.76
},
{
"x": 184.52,
"y": 179
},
{
"x": 203.5,
"y": 177.11
},
{
"x": 221.54,
"y": 174.5
},
{
"x": 221.62,
"y": 178.9
},
{
"x": 203.77,
"y": 182.13
},
{
"x": 184.82,
"y": 183.2
}
]
}
}
},
"example-2": {
"summary": "landmark150",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"face_num": "",
"face_list": [
{
"face_token": "",
"location": {
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"rotation": 0
}
}
],
"face_probability": 0,
"angle": [
{
"yaw": 0,
"pitch": 0,
"roll": 0
}
],
"age": 0,
"gender": [
{
"type": "",
"probability": 0
}
],
"landmark150": {
"cheek_right_1": {
"x": 101.17,
"y": 125.61
},
"cheek_right_3": {
"x": 108.34,
"y": 151.5
},
"cheek_right_5": {
"x": 117.67,
"y": 177.31
},
"cheek_right_7": {
"x": 130.68,
"y": 202.68
},
"cheek_right_9": {
"x": 155.9,
"y": 224.62
},
"cheek_right_11": {
"x": 183.48,
"y": 237
},
"chin_2": {
"x": 209.95,
"y": 239.3
},
"cheek_left_11": {
"x": 235.23,
"y": 228.95
},
"cheek_left_9": {
"x": 258.09,
"y": 207.98
},
"cheek_left_7": {
"x": 273.18,
"y": 182.04
},
"cheek_left_5": {
"x": 278.9,
"y": 155.82
},
"cheek_left_3": {
"x": 281.37,
"y": 129.89
},
"cheek_left_1": {
"x": 281.27,
"y": 104
},
"eye_right_corner_right": {
"x": 126.49,
"y": 107.15
},
"eye_right_eyelid_upper_2": {
"x": 135.48,
"y": 99.09
},
"eye_right_eyelid_upper_4": {
"x": 145.41,
"y": 95.26
},
"eye_right_eyelid_upper_6": {
"x": 156.55,
"y": 95.97
},
"eye_right_corner_left": {
"x": 167.67,
"y": 102.29
},
"eye_right_eyelid_lower_6": {
"x": 157.7,
"y": 105.12
},
"eye_right_eyelid_lower_4": {
"x": 147.3,
"y": 107.23
},
"eye_right_eyelid_lower_2": {
"x": 136.69,
"y": 107.99
},
"eye_right_eyeball_center": {
"x": 147.73,
"y": 101.24
},
"eyebrow_right_corner_right": {
"x": 110.57,
"y": 89.54
},
"eyebrow_right_upper_2": {
"x": 120.47,
"y": 73.12
},
"eyebrow_right_upper_3": {
"x": 135.87,
"y": 65.44
},
"eyebrow_right_upper_4": {
"x": 152.49,
"y": 62.99
},
"eyebrow_right_corner_left": {
"x": 168.56,
"y": 71.02
},
"eyebrow_right_lower_3": {
"x": 153.5,
"y": 73.48
},
"eyebrow_right_lower_2": {
"x": 137.76,
"y": 75.1
},
"eyebrow_right_lower_1": {
"x": 123.22,
"y": 80.01
},
"eye_left_corner_right": {
"x": 217.73,
"y": 96.79
},
"eye_left_eyelid_upper_2": {
"x": 226.52,
"y": 87.81
},
"eye_left_eyelid_upper_4": {
"x": 236.75,
"y": 84.47
},
"eye_left_eyelid_upper_6": {
"x": 246.87,
"y": 85.94
},
"eye_left_corner_left": {
"x": 256.55,
"y": 92.03
},
"eye_left_eyelid_lower_6": {
"x": 248.11,
"y": 94.97
},
"eye_left_eyelid_lower_4": {
"x": 238.51,
"y": 96.62
},
"eye_left_eyelid_lower_2": {
"x": 227.92,
"y": 97.09
},
"eye_left_eyeball_center": {
"x": 234.6,
"y": 91.21
},
"eyebrow_left_corner_right": {
"x": 209.77,
"y": 65.78
},
"eyebrow_left_upper_2": {
"x": 222.84,
"y": 54.59
},
"eyebrow_left_upper_3": {
"x": 238.19,
"y": 53.33
},
"eyebrow_left_upper_4": {
"x": 253.34,
"y": 57.53
},
"eyebrow_left_corner_left": {
"x": 265.02,
"y": 71.1
},
"eyebrow_left_lower_3": {
"x": 252.29,
"y": 65.16
},
"eyebrow_left_lower_2": {
"x": 238.71,
"y": 63.77
},
"eyebrow_left_lower_1": {
"x": 224.35,
"y": 65.26
},
"nose_right_contour_1": {
"x": 181.9,
"y": 101.3
},
"nose_right_contour_2": {
"x": 181.22,
"y": 116.47
},
"nose_right_contour_3": {
"x": 180.7,
"y": 131.63
},
"nose_right_contour_4": {
"x": 175.99,
"y": 149.51
},
"nose_right_contour_6": {
"x": 189.48,
"y": 147.54
},
"nose_left_contour_6": {
"x": 212.47,
"y": 145.01
},
"nose_left_contour_4": {
"x": 224.05,
"y": 143.94
},
"nose_left_contour_3": {
"x": 216.34,
"y": 127.18
},
"nose_left_contour_2": {
"x": 211.14,
"y": 112.7
},
"nose_left_contour_1": {
"x": 205.92,
"y": 98.39
},
"nose_tip": {
"x": 200.89,
"y": 133.62
},
"mouth_corner_right_outer": {
"x": 162.41,
"y": 181.04
},
"mouth_lip_upper_outer_3": {
"x": 181.13,
"y": 171.24
},
"mouth_lip_upper_outer_6": {
"x": 202.44,
"y": 167.4
},
"mouth_lip_upper_outer_9": {
"x": 222.59,
"y": 166.76
},
"mouth_corner_left_outer": {
"x": 240.34,
"y": 172.33
},
"mouth_lip_lower_outer_9": {
"x": 224.86,
"y": 187.02
},
"mouth_lip_lower_outer_6": {
"x": 204.89,
"y": 193.86
},
"mouth_lip_lower_outer_3": {
"x": 182.58,
"y": 191.98
},
"mouth_lip_upper_inner_3": {
"x": 182.7,
"y": 177.96
},
"mouth_lip_upper_inner_6": {
"x": 203.38,
"y": 176.09
},
"mouth_lip_upper_inner_9": {
"x": 222.51,
"y": 173.73
},
"mouth_lip_lower_inner_9": {
"x": 221.9,
"y": 179.01
},
"mouth_lip_lower_inner_6": {
"x": 203.69,
"y": 182.54
},
"mouth_lip_lower_inner_3": {
"x": 183.96,
"y": 183.65
},
"cheek_right_2": {
"x": 104.6,
"y": 138.43
},
"cheek_right_4": {
"x": 112.96,
"y": 164.49
},
"cheek_right_6": {
"x": 123.26,
"y": 190.89
},
"cheek_right_8": {
"x": 142.17,
"y": 214.95
},
"cheek_right_10": {
"x": 169.18,
"y": 232.05
},
"chin_1": {
"x": 196.41,
"y": 239.76
},
"chin_3": {
"x": 223.56,
"y": 235.7
},
"cheek_left_10": {
"x": 247.53,
"y": 219.37
},
"cheek_left_8": {
"x": 266.71,
"y": 195.68
},
"cheek_left_6": {
"x": 276.63,
"y": 169.29
},
"cheek_left_4": {
"x": 280.27,
"y": 142.91
},
"cheek_left_2": {
"x": 281.37,
"y": 116.87
},
"eyebrow_right_upper_1": {
"x": 110.33,
"y": 86.28
},
"eyebrow_right_upper_5": {
"x": 167.9,
"y": 65.41
},
"eyebrow_left_upper_1": {
"x": 209.28,
"y": 60.27
},
"eyebrow_left_upper_5": {
"x": 264.85,
"y": 68.07
},
"eye_right_eyelid_upper_1": {
"x": 130.38,
"y": 102.52
},
"eye_right_eyelid_upper_3": {
"x": 140.08,
"y": 96.4
},
"eye_right_eyelid_upper_5": {
"x": 151.2,
"y": 94.82
},
"eye_right_eyelid_upper_7": {
"x": 162.52,
"y": 98.42
},
"eye_right_eyelid_lower_7": {
"x": 162.65,
"y": 103.84
},
"eye_right_eyelid_lower_5": {
"x": 152.66,
"y": 106.6
},
"eye_right_eyelid_lower_3": {
"x": 142,
"y": 108.14
},
"eye_right_eyelid_lower_1": {
"x": 131.72,
"y": 107.84
},
"eye_right_eyeball_right": {
"x": 138.8,
"y": 103.02
},
"eye_right_eyeball_left": {
"x": 156.44,
"y": 100.95
},
"eye_left_eyelid_upper_1": {
"x": 221.4,
"y": 91.57
},
"eye_left_eyelid_upper_3": {
"x": 231.34,
"y": 85.37
},
"eye_left_eyelid_upper_5": {
"x": 242.07,
"y": 84.4
},
"eye_left_eyelid_upper_7": {
"x": 252.15,
"y": 88.32
},
"eye_left_eyelid_lower_7": {
"x": 252.22,
"y": 93.63
},
"eye_left_eyelid_lower_5": {
"x": 243.5,
"y": 96.25
},
"eye_left_eyelid_lower_3": {
"x": 233.22,
"y": 97.32
},
"eye_left_eyelid_lower_1": {
"x": 222.85,
"y": 97.09
},
"eye_left_eyeball_right": {
"x": 226.11,
"y": 92.86
},
"eye_left_eyeball_left": {
"x": 243.41,
"y": 90.77
},
"nose_bridge_1": {
"x": 194.72,
"y": 99.62
},
"nose_bridge_2": {
"x": 197.27,
"y": 114.38
},
"nose_bridge_3": {
"x": 199.84,
"y": 129.18
},
"nose_right_contour_5": {
"x": 184.36,
"y": 154.78
},
"nose_right_contour_7": {
"x": 187.97,
"y": 142.32
},
"nose_left_contour_7": {
"x": 212.98,
"y": 139.24
},
"nose_left_contour_5": {
"x": 217.81,
"y": 151.08
},
"nose_middle_contour": {
"x": 201.68,
"y": 154.12
},
"mouth_corner_right_inner": {
"x": 165.3,
"y": 181
},
"mouth_corner_left_inner": {
"x": 237.92,
"y": 172.84
},
"mouth_lip_upper_outer_1": {
"x": 168.01,
"y": 176.99
},
"mouth_lip_upper_outer_2": {
"x": 174.3,
"y": 173.78
},
"mouth_lip_upper_outer_4": {
"x": 187.89,
"y": 168.51
},
"mouth_lip_upper_outer_5": {
"x": 194.93,
"y": 167.13
},
"mouth_lip_upper_outer_7": {
"x": 209.22,
"y": 165.76
},
"mouth_lip_upper_outer_8": {
"x": 215.94,
"y": 165.52
},
"mouth_lip_upper_outer_10": {
"x": 229.05,
"y": 167.86
},
"mouth_lip_upper_outer_11": {
"x": 234.91,
"y": 169.69
},
"mouth_lip_lower_outer_11": {
"x": 235.77,
"y": 177.88
},
"mouth_lip_lower_outer_10": {
"x": 230.91,
"y": 182.95
},
"mouth_lip_lower_outer_8": {
"x": 218.84,
"y": 190.53
},
"mouth_lip_lower_outer_7": {
"x": 212.21,
"y": 192.9
},
"mouth_lip_lower_outer_5": {
"x": 197.36,
"y": 194.88
},
"mouth_lip_lower_outer_4": {
"x": 189.8,
"y": 194.21
},
"mouth_lip_lower_outer_2": {
"x": 175.21,
"y": 189.57
},
"mouth_lip_lower_outer_1": {
"x": 168.57,
"y": 185.65
},
"mouth_lip_upper_inner_1": {
"x": 169.33,
"y": 179.63
},
"mouth_lip_upper_inner_2": {
"x": 175.82,
"y": 178.66
},
"mouth_lip_upper_inner_4": {
"x": 189.52,
"y": 176.75
},
"mouth_lip_upper_inner_5": {
"x": 196.11,
"y": 176.01
},
"mouth_lip_upper_inner_7": {
"x": 209.81,
"y": 174.66
},
"mouth_lip_upper_inner_8": {
"x": 216.02,
"y": 173.94
},
"mouth_lip_upper_inner_10": {
"x": 228.56,
"y": 172.95
},
"mouth_lip_upper_inner_11": {
"x": 234.11,
"y": 172.49
},
"mouth_lip_lower_inner_11": {
"x": 234.25,
"y": 175.35
},
"mouth_lip_lower_inner_10": {
"x": 228.41,
"y": 177.24
},
"mouth_lip_lower_inner_8": {
"x": 215.75,
"y": 180.22
},
"mouth_lip_lower_inner_7": {
"x": 209.89,
"y": 181.33
},
"mouth_lip_lower_inner_5": {
"x": 197.09,
"y": 183.02
},
"mouth_lip_lower_inner_4": {
"x": 190.67,
"y": 183.38
},
"mouth_lip_lower_inner_2": {
"x": 176.59,
"y": 183.43
},
"mouth_lip_lower_inner_1": {
"x": 169.73,
"y": 182.83
}
}
}
}
},
"example-3": {
"summary": "landmark201",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"result": {
"face_num": "",
"face_list": [
{
"face_token": "",
"location": {
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"rotation": 0
}
}
],
"face_probability": 0,
"angle": [
{
"yaw": 0,
"pitch": 0,
"roll": 0
}
],
"age": 0,
"gender": [
{
"type": "",
"probability": 0
}
],
"landmark201": {
"cheek_right_1": {
"x": 100.50280761719,
"y": 122.91817474365
},
"cheek_right_3": {
"x": 107.60373687744,
"y": 148.26614379883
},
"cheek_right_5": {
"x": 117.18408966064,
"y": 173.37020874023
},
"cheek_right_7": {
"x": 129.51084899902,
"y": 198.14645385742
},
"cheek_right_9": {
"x": 153.17233276367,
"y": 221.0482635498
},
"cheek_right_11": {
"x": 182.12239074707,
"y": 236.04145812988
},
"chin_2": {
"x": 209.19718933105,
"y": 238.74569702148
},
"cheek_left_11": {
"x": 233.98812866211,
"y": 228.61196899414
},
"cheek_left_9": {
"x": 257.15982055664,
"y": 206.74928283691
},
"cheek_left_7": {
"x": 273.24240112305,
"y": 179.74179077148
},
"cheek_left_5": {
"x": 278.9245300293,
"y": 153.36854553223
},
"cheek_left_3": {
"x": 281.60067749023,
"y": 127.45653533936
},
"cheek_left_1": {
"x": 281.65811157227,
"y": 101.97602844238
},
"eye_right_corner_right": {
"x": 126.41732025146,
"y": 106.01263427734
},
"eye_right_eyelid_upper_2": {
"x": 135.80418395996,
"y": 98.718200683594
},
"eye_right_eyelid_upper_4": {
"x": 146.0609588623,
"y": 95.352470397949
},
"eye_right_eyelid_upper_6": {
"x": 156.98849487305,
"y": 96.707542419434
},
"eye_right_corner_left": {
"x": 167.77938842773,
"y": 103.75801086426
},
"eye_right_eyelid_lower_6": {
"x": 157.17764282227,
"y": 105.32893371582
},
"eye_right_eyelid_lower_4": {
"x": 146.6658782959,
"y": 107.00431060791
},
"eye_right_eyelid_lower_2": {
"x": 136.29998779297,
"y": 107.18744659424
},
"eye_right_eyeball_center": {
"x": 149.03952026367,
"y": 100.88204193115
},
"eyebrow_right_corner_right": {
"x": 111.89064025879,
"y": 89.201026916504
},
"eyebrow_right_upper_2": {
"x": 122.31422424316,
"y": 73.421539306641
},
"eyebrow_right_upper_3": {
"x": 137.08978271484,
"y": 66.036170959473
},
"eyebrow_right_upper_4": {
"x": 153.29194641113,
"y": 63.859962463379
},
"eyebrow_right_corner_left": {
"x": 169.60948181152,
"y": 71.236366271973
},
"eyebrow_right_lower_3": {
"x": 154.23251342773,
"y": 73.722877502441
},
"eyebrow_right_lower_2": {
"x": 139.03732299805,
"y": 75.76969909668
},
"eyebrow_right_lower_1": {
"x": 124.95774078369,
"y": 80.54305267334
},
"eye_left_corner_right": {
"x": 217.01159667969,
"y": 97.617874145508
},
"eye_left_eyelid_upper_2": {
"x": 226.2021484375,
"y": 88.830413818359
},
"eye_left_eyelid_upper_4": {
"x": 236.49551391602,
"y": 85.042304992676
},
"eye_left_eyelid_upper_6": {
"x": 247.1067199707,
"y": 85.98779296875
},
"eye_left_corner_left": {
"x": 257.17602539062,
"y": 91.660705566406
},
"eye_left_eyelid_lower_6": {
"x": 248.03689575195,
"y": 94.483413696289
},
"eye_left_eyelid_lower_4": {
"x": 237.9640045166,
"y": 96.363983154297
},
"eye_left_eyelid_lower_2": {
"x": 227.42778015137,
"y": 96.841079711914
},
"eye_left_eyeball_center": {
"x": 236.41227722168,
"y": 90.83772277832
},
"eyebrow_left_corner_right": {
"x": 210.22798156738,
"y": 66.922027587891
},
"eyebrow_left_upper_2": {
"x": 223.81993103027,
"y": 56.301136016846
},
"eyebrow_left_upper_3": {
"x": 239.48515319824,
"y": 54.885005950928
},
"eyebrow_left_upper_4": {
"x": 254.61218261719,
"y": 58.917163848877
},
"eyebrow_left_corner_left": {
"x": 266.93252563477,
"y": 71.747833251953
},
"eyebrow_left_lower_3": {
"x": 253.65521240234,
"y": 66.255722045898
},
"eyebrow_left_lower_2": {
"x": 239.84336853027,
"y": 64.663993835449
},
"eyebrow_left_lower_1": {
"x": 225.20980834961,
"y": 65.903739929199
},
"nose_right_contour_1": {
"x": 181.20947265625,
"y": 102.47806549072
},
"nose_right_contour_2": {
"x": 180.53022766113,
"y": 117.22489929199
},
"nose_right_contour_3": {
"x": 179.75746154785,
"y": 131.87655639648
},
"nose_right_contour_4": {
"x": 175.17123413086,
"y": 149.65969848633
},
"nose_right_contour_6": {
"x": 187.9427947998,
"y": 148.60627746582
},
"nose_left_contour_6": {
"x": 211.91970825195,
"y": 146.00950622559
},
"nose_left_contour_4": {
"x": 223.48764038086,
"y": 144.13488769531
},
"nose_left_contour_3": {
"x": 215.23889160156,
"y": 127.75564575195
},
"nose_left_contour_2": {
"x": 210.45150756836,
"y": 113.83534240723
},
"nose_left_contour_1": {
"x": 205.66767883301,
"y": 99.799003601074
},
"nose_tip": {
"x": 199.36351013184,
"y": 135.43583679199
},
"mouth_corner_right_outer": {
"x": 164.51684570312,
"y": 180.21446228027
},
"mouth_lip_upper_outer_3": {
"x": 183.04803466797,
"y": 173.05368041992
},
"mouth_lip_upper_outer_6": {
"x": 202.40353393555,
"y": 169.86236572266
},
"mouth_lip_upper_outer_9": {
"x": 221.34548950195,
"y": 168.33967590332
},
"mouth_corner_left_outer": {
"x": 239.35760498047,
"y": 171.47436523438
},
"mouth_lip_lower_outer_9": {
"x": 225.13409423828,
"y": 186.8864440918
},
"mouth_lip_lower_outer_6": {
"x": 205.00257873535,
"y": 194.42323303223
},
"mouth_lip_lower_outer_3": {
"x": 183.21276855469,
"y": 191.83988952637
},
"mouth_lip_upper_inner_3": {
"x": 184.11585998535,
"y": 179.77445983887
},
"mouth_lip_upper_inner_6": {
"x": 203.41976928711,
"y": 178.58102416992
},
"mouth_lip_upper_inner_9": {
"x": 221.72236633301,
"y": 175.30459594727
},
"mouth_lip_lower_inner_9": {
"x": 221.91030883789,
"y": 178.33660888672
},
"mouth_lip_lower_inner_6": {
"x": 203.65730285645,
"y": 182.15875244141
},
"mouth_lip_lower_inner_3": {
"x": 184.51734924316,
"y": 182.77604675293
},
"cheek_right_2": {
"x": 103.98864746094,
"y": 135.52793884277
},
"cheek_right_4": {
"x": 112.40145874023,
"y": 160.84996032715
},
"cheek_right_6": {
"x": 122.82944488525,
"y": 186.40303039551
},
"cheek_right_8": {
"x": 140.21722412109,
"y": 210.5570526123
},
"cheek_right_10": {
"x": 167.3126373291,
"y": 229.57949829102
},
"chin_1": {
"x": 195.2822265625,
"y": 239.18600463867
},
"chin_3": {
"x": 222.51171875,
"y": 235.33393859863
},
"cheek_left_10": {
"x": 246.1284942627,
"y": 218.42253112793
},
"cheek_left_8": {
"x": 266.35614013672,
"y": 193.8251953125
},
"cheek_left_6": {
"x": 276.64300537109,
"y": 166.97787475586
},
"cheek_left_4": {
"x": 280.34902954102,
"y": 140.4186706543
},
"cheek_left_2": {
"x": 281.71441650391,
"y": 114.67360687256
},
"eyebrow_right_upper_1": {
"x": 111.35711669922,
"y": 86.627182006836
},
"eyebrow_right_upper_5": {
"x": 168.99195861816,
"y": 66.651916503906
},
"eyebrow_left_upper_1": {
"x": 209.73815917969,
"y": 62.367111206055
},
"eyebrow_left_upper_5": {
"x": 266.84356689453,
"y": 69.139381408691
},
"eye_right_eyelid_upper_1": {
"x": 130.77444458008,
"y": 101.91876983643
},
"eye_right_eyelid_upper_3": {
"x": 140.63957214355,
"y": 96.40283203125
},
"eye_right_eyelid_upper_5": {
"x": 151.72430419922,
"y": 95.306747436523
},
"eye_right_eyelid_upper_7": {
"x": 162.74897766113,
"y": 99.496116638184
},
"eye_right_eyelid_lower_7": {
"x": 162.38629150391,
"y": 104.49882507324
},
"eye_right_eyelid_lower_5": {
"x": 151.98274230957,
"y": 106.52454376221
},
"eye_right_eyelid_lower_3": {
"x": 141.43927001953,
"y": 107.55311584473
},
"eye_right_eyelid_lower_1": {
"x": 131.48648071289,
"y": 106.77459716797
},
"eye_right_eyeball_right": {
"x": 140.33833312988,
"y": 102.34557342529
},
"eye_right_eyeball_left": {
"x": 157.28521728516,
"y": 100.5290222168
},
"eye_left_eyelid_upper_1": {
"x": 221.15461730957,
"y": 92.644577026367
},
"eye_left_eyelid_upper_3": {
"x": 231.00561523438,
"y": 86.285903930664
},
"eye_left_eyelid_upper_5": {
"x": 241.99041748047,
"y": 84.785552978516
},
"eye_left_eyelid_upper_7": {
"x": 252.52342224121,
"y": 88.264419555664
},
"eye_left_eyelid_lower_7": {
"x": 252.53790283203,
"y": 93.202026367188
},
"eye_left_eyelid_lower_5": {
"x": 243.14991760254,
"y": 95.852195739746
},
"eye_left_eyelid_lower_3": {
"x": 232.71337890625,
"y": 96.973175048828
},
"eye_left_eyelid_lower_1": {
"x": 222.30973815918,
"y": 97.109771728516
},
"eye_left_eyeball_right": {
"x": 227.80111694336,
"y": 92.332466125488
},
"eye_left_eyeball_left": {
"x": 245.25280761719,
"y": 90.477554321289
},
"nose_bridge_1": {
"x": 194.00415039062,
"y": 101.13747406006
},
"nose_bridge_2": {
"x": 196.17010498047,
"y": 115.36420440674
},
"nose_bridge_3": {
"x": 198.33186340332,
"y": 129.53858947754
},
"nose_right_contour_5": {
"x": 183.04495239258,
"y": 155.09115600586
},
"nose_right_contour_7": {
"x": 186.44073486328,
"y": 144.0689239502
},
"nose_left_contour_7": {
"x": 212.54084777832,
"y": 141.23469543457
},
"nose_left_contour_5": {
"x": 217.43865966797,
"y": 151.00485229492
},
"nose_middle_contour": {
"x": 200.85198974609,
"y": 154.55256652832
},
"mouth_corner_right_inner": {
"x": 167.02519226074,
"y": 180.40368652344
},
"mouth_corner_left_inner": {
"x": 237.12232971191,
"y": 172.1975402832
},
"mouth_lip_upper_outer_1": {
"x": 170.21281433105,
"y": 177.35729980469
},
"mouth_lip_upper_outer_2": {
"x": 176.45417785645,
"y": 174.93753051758
},
"mouth_lip_upper_outer_4": {
"x": 189.13919067383,
"y": 170.50596618652
},
"mouth_lip_upper_outer_5": {
"x": 195.6019744873,
"y": 169.47576904297
},
"mouth_lip_upper_outer_7": {
"x": 208.75428771973,
"y": 167.95617675781
},
"mouth_lip_upper_outer_8": {
"x": 215.07498168945,
"y": 167.36375427246
},
"mouth_lip_upper_outer_10": {
"x": 227.73937988281,
"y": 168.76318359375
},
"mouth_lip_upper_outer_11": {
"x": 233.7864074707,
"y": 169.83984375
},
"mouth_lip_lower_outer_11": {
"x": 235.34422302246,
"y": 177.24853515625
},
"mouth_lip_lower_outer_10": {
"x": 230.79676818848,
"y": 182.67813110352
},
"mouth_lip_lower_outer_8": {
"x": 219.44760131836,
"y": 191.05749511719
},
"mouth_lip_lower_outer_7": {
"x": 212.53646850586,
"y": 193.67753601074
},
"mouth_lip_lower_outer_5": {
"x": 197.43534851074,
"y": 195.48767089844
},
"mouth_lip_lower_outer_4": {
"x": 189.89576721191,
"y": 194.59895324707
},
"mouth_lip_lower_outer_2": {
"x": 176.30549621582,
"y": 189.13090515137
},
"mouth_lip_lower_outer_1": {
"x": 170.18327331543,
"y": 184.91101074219
},
"mouth_lip_upper_inner_1": {
"x": 171.22261047363,
"y": 179.89912414551
},
"mouth_lip_upper_inner_2": {
"x": 177.46989440918,
"y": 179.81153869629
},
"mouth_lip_upper_inner_4": {
"x": 190.59698486328,
"y": 179.11518859863
},
"mouth_lip_upper_inner_5": {
"x": 196.8454284668,
"y": 178.71240234375
},
"mouth_lip_upper_inner_7": {
"x": 209.58256530762,
"y": 177.28843688965
},
"mouth_lip_upper_inner_8": {
"x": 215.52067565918,
"y": 176.19625854492
},
"mouth_lip_upper_inner_10": {
"x": 227.71615600586,
"y": 173.85404968262
},
"mouth_lip_upper_inner_11": {
"x": 233.29223632812,
"y": 172.57704162598
},
"mouth_lip_lower_inner_11": {
"x": 233.62571716309,
"y": 174.40519714355
},
"mouth_lip_lower_inner_10": {
"x": 228.07106018066,
"y": 176.48277282715
},
"mouth_lip_lower_inner_8": {
"x": 215.9122467041,
"y": 179.73753356934
},
"mouth_lip_lower_inner_7": {
"x": 209.95574951172,
"y": 181.01141357422
},
"mouth_lip_lower_inner_5": {
"x": 197.13244628906,
"y": 182.56121826172
},
"mouth_lip_lower_inner_4": {
"x": 190.87368774414,
"y": 182.73983764648
},
"mouth_lip_lower_inner_2": {
"x": 177.65509033203,
"y": 182.41763305664
},
"mouth_lip_lower_inner_1": {
"x": 171.26217651367,
"y": 181.71365356445
},
"iris_left_1": {
"x": 149.40379333496,
"y": 100.07892608643
},
"iris_left_2": {
"x": 148.73318481445,
"y": 92.03369140625
},
"iris_left_3": {
"x": 146.30757141113,
"y": 92.544448852539
},
"iris_left_4": {
"x": 143.84558105469,
"y": 93.900978088379
},
"iris_left_5": {
"x": 142.10343933105,
"y": 95.915756225586
},
"iris_left_6": {
"x": 141.19898986816,
"y": 98.484413146973
},
"iris_left_7": {
"x": 141.20487976074,
"y": 101.20999908447
},
"iris_left_8": {
"x": 142.08467102051,
"y": 103.90132904053
},
"iris_left_9": {
"x": 143.65046691895,
"y": 106.00126647949
},
"iris_left_10": {
"x": 146.09100341797,
"y": 107.37795257568
},
"iris_left_11": {
"x": 148.82292175293,
"y": 107.85302734375
},
"iris_left_12": {
"x": 151.54568481445,
"y": 107.596534729
},
"iris_left_13": {
"x": 154.05340576172,
"y": 106.52443695068
},
"iris_left_14": {
"x": 156.02444458008,
"y": 104.7774887085
},
"iris_left_15": {
"x": 157.17826843262,
"y": 102.40663909912
},
"iris_left_16": {
"x": 157.39999389648,
"y": 99.654823303223
},
"iris_left_17": {
"x": 156.83882141113,
"y": 97.051910400391
},
"iris_left_18": {
"x": 155.60954284668,
"y": 94.735946655273
},
"iris_left_19": {
"x": 153.60211181641,
"y": 93.047943115234
},
"iris_left_20": {
"x": 151.11714172363,
"y": 92.191055297852
},
"iris_right_1": {
"x": 236.5496673584,
"y": 89.82470703125
},
"iris_right_2": {
"x": 235.57327270508,
"y": 81.906242370605
},
"iris_right_3": {
"x": 233.22520446777,
"y": 82.437240600586
},
"iris_right_4": {
"x": 230.8776550293,
"y": 83.811805725098
},
"iris_right_5": {
"x": 228.99620056152,
"y": 85.852684020996
},
"iris_right_6": {
"x": 228.28205871582,
"y": 88.459457397461
},
"iris_right_7": {
"x": 228.09143066406,
"y": 91.328216552734
},
"iris_right_8": {
"x": 228.9642791748,
"y": 93.888366699219
},
"iris_right_9": {
"x": 230.59039306641,
"y": 96.080490112305
},
"iris_right_10": {
"x": 233.10903930664,
"y": 97.431625366211
},
"iris_right_11": {
"x": 235.84417724609,
"y": 97.806510925293
},
"iris_right_12": {
"x": 238.75238037109,
"y": 97.537010192871
},
"iris_right_13": {
"x": 241.33396911621,
"y": 96.534019470215
},
"iris_right_14": {
"x": 243.4416809082,
"y": 94.684562683105
},
"iris_right_15": {
"x": 244.63690185547,
"y": 92.331932067871
},
"iris_right_16": {
"x": 245.06533813477,
"y": 89.467132568359
},
"iris_right_17": {
"x": 244.44647216797,
"y": 86.712936401367
},
"iris_right_18": {
"x": 243.01428222656,
"y": 84.355781555176
},
"iris_right_19": {
"x": 240.87191772461,
"y": 82.740913391113
},
"iris_right_20": {
"x": 238.14981079102,
"y": 81.91431427002
},
"forehead_center": {
"x": 176.53311157227,
"y": -6.304919719696
},
"forehead_right_1": {
"x": 149.34216308594,
"y": -0.85879385471344
},
"forehead_right_2": {
"x": 124.94794464111,
"y": 12.06137752533
},
"forehead_right_3": {
"x": 107.58184814453,
"y": 33.489730834961
},
"forehead_right_4": {
"x": 98.957183837891,
"y": 59.803108215332
},
"forehead_right_5": {
"x": 97.01008605957,
"y": 87.569114685059
},
"forehead_left_1": {
"x": 203.49537658691,
"y": -6.5926675796509
},
"forehead_left_2": {
"x": 229.22273254395,
"y": 0.93864995241165
},
"forehead_left_3": {
"x": 250.55792236328,
"y": 17.390432357788
},
"forehead_left_4": {
"x": 265.51229858398,
"y": 40.023624420166
},
"forehead_left_5": {
"x": 274.67761230469,
"y": 65.599334716797
}
}
}
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/skin-analysis": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "Skin Analyze",
"description": "Skin Analyze API detects skin type, tone, eye bags, dark circles, wrinkles, acne, spots, and other skin conditions.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "Main Image.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"warning": [],
"face_rectangle": {
"top": 0,
"left": 0,
"width": 0,
"height": 0
},
"result": {
"left_eyelids": {
"value": 0,
"confidence": 0.89
},
"right_eyelids": {
"value": 0,
"confidence": 0.89
},
"eye_pouch": {
"value": 0,
"confidence": 0.89
},
"dark_circle": {
"value": 0,
"confidence": 0.89
},
"forehead_wrinkle": {
"value": 0,
"confidence": 0.89
},
"crows_feet": {
"value": 0,
"confidence": 0.89
},
"eye_finelines": {
"value": 0,
"confidence": 0.89
},
"glabella_wrinkle": {
"value": 0,
"confidence": 0.89
},
"nasolabial_fold": {
"value": 0,
"confidence": 0.89
},
"skin_type": {
"skin_type": 0,
"details": {
"0": {
"value": 1,
"confidence": 0.89
},
"1": {
"value": 1,
"confidence": 0.89
},
"2": {
"value": 1,
"confidence": 0.89
},
"3": {
"value": 1,
"confidence": 0.89
}
}
},
"pores": {
"value": 0,
"confidence": 1
},
"pores_forehead": {
"value": 0,
"confidence": 1
},
"pores_left_cheek": {
"value": 0,
"confidence": 1
},
"pores_right_cheek": {
"value": 0,
"confidence": 1
},
"pores_jaw": {
"value": 0,
"confidence": 1
},
"blackhead": {
"value": 0,
"confidence": 1
},
"acne": {
"value": 0,
"confidence": 1
},
"mole": {
"value": 0,
"confidence": 1
},
"skin_spot": {
"value": 0,
"confidence": 1
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/skin-analysis-advanced": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "Skin Analyze Advanced",
"description": "Skin Analyze Advanced API detects skin type, tone, eye bags, dark circles, wrinkles, acne, spots, and other skin conditions.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Main Image.",
"format": "binary"
},
"face_quality_control": {
"type": "string",
"description": "Whether to restrict the quality of faces in incoming images. `0`: No face quality control is performed, and skin measurement results are returned as long as the face can be detected. `1`: Perform face quality control, if the face quality does not pass it will prompt an error."
},
"return_rect_confidence": {
"type": "string",
"description": "The confidence level of the area whether to return acne, occlusion, blemishes and moles. `0`: No regional confidence is returned. `1`: Returns the regional confidence."
},
"return_maps": {
"type": "string",
"description": "Enter a comma-separated string containing the type of skin chromatography image to be returned."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"warning": [],
"face_rectangle": {
"top": 0,
"left": 0,
"width": 0,
"height": 0
},
"result": {
"skin_color": {
"value": 0,
"confidence": 0.89
},
"skin_age": {
"value": 9
},
"left_eyelids": {
"value": 0,
"confidence": 0.89
},
"right_eyelids": {
"value": 0,
"confidence": 0.89
},
"eye_pouch": {
"value": 0,
"confidence": 0.89
},
"dark_circle": {
"value": 0,
"confidence": 0.89
},
"forehead_wrinkle": {
"value": 0,
"confidence": 0.89
},
"crows_feet": {
"value": 0,
"confidence": 0.89
},
"eye_finelines": {
"value": 0,
"confidence": 0.89
},
"glabella_wrinkle": {
"value": 0,
"confidence": 0.89
},
"nasolabial_fold": {
"value": 0,
"confidence": 0.89
},
"skin_type": {
"skin_type": 0,
"details": {
"0": {
"value": 1,
"confidence": 0.89
},
"1": {
"value": 1,
"confidence": 0.89
},
"2": {
"value": 0,
"confidence": 0.01
},
"3": {
"value": 0,
"confidence": 0.01
}
}
},
"pores_forehead": {
"value": 0,
"confidence": 1
},
"pores_left_cheek": {
"value": 0,
"confidence": 1
},
"pores_right_cheek": {
"value": 0,
"confidence": 1
},
"pores_jaw": {
"value": 0,
"confidence": 1
},
"blackhead": {
"value": 0,
"confidence": 1
},
"acne": {
"rectangle": [
{
"width": 3,
"top": 17,
"height": 1,
"left": 35
},
{
"width": 4,
"top": 20,
"height": 1,
"left": 35
}
]
},
"closed_comedones": {
"rectangle": [
{
"width": 3,
"top": 17,
"height": 1,
"left": 35
},
{
"width": 4,
"top": 20,
"height": 1,
"left": 35
}
]
},
"mole": {
"rectangle": [
{
"width": 3,
"top": 17,
"height": 1,
"left": 35
},
{
"width": 4,
"top": 20,
"height": 1,
"left": 35
}
]
},
"skin_spot": {
"rectangle": [
{
"width": 3,
"top": 17,
"height": 1,
"left": 35
},
{
"width": 4,
"top": 20,
"height": 1,
"left": 35
}
]
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/skin-analysis-pro": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "Skin Analyze Pro",
"description": "Skin Analyze Pro API analyzes skin texture, tone, wrinkles, acne, spots, eye bags, and other facial skin conditions.",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Main Image.",
"format": "binary"
},
"left_side_image": {
"type": "string",
"description": "Side face picture.(Left)",
"format": "binary"
},
"right_side_image": {
"type": "string",
"description": "Side face picture.(Right)",
"format": "binary"
},
"return_maps": {
"type": "string",
"description": "The type of skin problem detection mapping image to be returned. If the corresponding element parameter is passed in, the interface will return an image of the original size, which you can subsequently overlay with the original image to see the results. Use commas to separate multiple types."
},
"return_marks": {
"type": "string",
"description": "The type of skin problem detection mapping image to be returned. Use commas to separate multiple types."
},
"roi_outline_color": {
"type": "string",
"description": "Customize the color."
},
"return_side_results": {
"type": "string",
"description": "The side face information that needs to be returned. Use commas to separate multiple types."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"face_rectangle": {
"top": 0,
"left": 0,
"width": 0,
"height": 0
},
"left_side_result": {
"left_jawline_quality": 1,
"left_jawline_angle": 122.73,
"left_jawline_mark": [
{
"x": 518,
"y": 1256
},
{
"x": 531,
"y": 1260
}
]
},
"right_jawline_info": {
"right_jawline_quality": 1,
"right_jawline_angle": 122.73,
"right_jawline_mark": [
{
"x": 518,
"y": 1256
},
{
"x": 531,
"y": 1260
}
]
},
"result": {
"image_quality": {
"face_ratio:": 0.3,
"face_orientation": {
"yaw": 30.1,
"pitch": 21.2,
"roll": 89
},
"face_rect": {
"top": 808,
"left": 677,
"width": 800,
"height": 800
},
"hair_occlusion": 0.05,
"glasses": 0
},
"skin_type": {
"skin_type": 0,
"details": {
"0": {
"value": 0,
"confidence": 0.89
},
"1": {
"value": 0,
"confidence": 0.89
},
"2": {
"value": 1,
"confidence": 0.89
},
"3": {
"value": 0,
"confidence": 0.89
}
}
},
"oily_intensity": {
"t_zone": {
"area": 0,
"intensity": 0
},
"left_cheek": {
"area": 0,
"intensity": 0
},
"right_cheek": {
"area": 0,
"intensity": 0
},
"chin_area": {
"area": 0,
"intensity": 0
}
},
"water": {
"water_severity": 0,
"water_area": 0,
"water_forehead": {
"area": 0
},
"water_leftcheek": {
"area": 0
},
"water_rightcheek": {
"area": 0
}
},
"skin_tone": {
"value": 0,
"confidence": 0
},
"skintone_ita": {
"ITA": 0,
"skintone": 0
},
"skin_hue_ha": {
"HA": 0,
"skin_hue": 0
},
"blackhead": {
"value": 0,
"confidence": 0
},
"blackhead_count": 0,
"enlarged_pore_count": {
"forehead": {
"count": 0,
"area": 0
},
"left_cheek_count": {
"count": 0,
"area": 0
},
"right_cheek_count": {
"count": 0,
"area": 0
},
"chin_count": {
"count": 0,
"area": 0
}
},
"pores_forehead": {
"value": 0,
"confidence": 0
},
"pores_rightcheek": {
"value": 0,
"confidence": 0
},
"pores_leftcheek": {
"value": 0,
"confidence": 0
},
"pores_jaw": {
"value": 0,
"confidence": 0
},
"rough": {
"rough_severity": 0,
"rough_area": 0,
"rough_forehead": {
"area": 0
},
"rough_leftcheek": {
"area": 0
},
"rough_rightcheek": {
"area": 0
},
"rough_jaw": {
"area": 0
}
},
"melanin": {
"brown_area": 0,
"melanin_concentration": 0,
"brown_forehead": 0,
"brown_leftcheek": 0,
"brown_rightcheek": 0
},
"melanin_mark": {
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"mole": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"brown_spot": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"melasma": {
"value": 0,
"confidence": 0
},
"freckle": {
"value": 0,
"confidence": 0
},
"acne": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"acne_pustule": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"acne_nodule": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"acne_mark": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"closed_comedones": {
"rectangle": [
{
"width": 0,
"top": 0,
"height": 0,
"left": 0
}
],
"confidence": [
0
],
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"sensitivity": {
"sensitivity_area": 0,
"sensitivity_intensity": 0
},
"sensitivity_mark": {
"polygon": [
[
{
"x": 0,
"y": 0
}
]
]
},
"skin_age": {
"value": 0
},
"forehead_wrinkle": {
"value": 0,
"confidence": 0
},
"crows_feet": {
"value": 0,
"confidence": 0
},
"eye_finelines": {
"value": 0,
"confidence": 0
},
"glabella_wrinkle": {
"value": 0,
"confidence": 0
},
"nasolabial_fold": {
"value": 0,
"confidence": 0
},
"nasolabial_fold_severity": {
"value": 0,
"confidence": 0
},
"left_mouth_wrinkle_severity": {
"value": 0
},
"right_mouth_wrinkle_severity": {
"value": 0
},
"forehead_wrinkle_severity": {
"value": 0
},
"left_crows_feet_severity": {
"value": 0
},
"right_crows_feet_severity": {
"value": 0
},
"left_eye_finelines_severity": {
"value": 0
},
"right_eye_finelines_severity": {
"value": 0
},
"glabella_wrinkle_severity": {
"value": 0
},
"left_nasolabial_fold_severity": {
"value": 0
},
"right_nasolabial_fold_severity": {
"value": 0
},
"left_cheek_wrinkle_severity": {
"value": 0
},
"right_cheek_wrinkle_severity": {
"value": 0
},
"fine_line": {
"forehead_count": 0,
"left_undereye_count": 0,
"right_undereye_count": 0,
"left_cheek_count": 0,
"right_cheek_count": 0,
"left_crowsfeet_count": 0,
"right_crowsfeet_count": 0,
"glabella_count": 0
},
"wrinkle_count": {
"forehead_count": 0,
"left_undereye_count": 0,
"right_undereye_count": 0,
"left_mouth_count": 0,
"right_mouth_count": 0,
"left_nasolabial_count": 0,
"right_nasolabial_count": 0,
"glabella_count": 0,
"left_cheek_count": 0,
"right_cheek_count": 0,
"left_crowsfeet_count": 0,
"right_crowsfeet_count": 0
},
"forehead_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"forehead_wrinkle_list": []
},
"left_eye_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"left_eye_wrinkle_list": []
},
"right_eye_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"right_eye_wrinkle_list": []
},
"left_crowsfeet_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"left_crowsfeet_wrinkle_list": []
},
"right_crowsfeet_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"right_crowsfeet_wrinkle_list": []
},
"glabella_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"glabella_wrinkle_list": []
},
"left_mouth_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"left_mouth_wrinkle_list": []
},
"right_mouth_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"right_mouth_wrinkle_list": []
},
"left_nasolabial_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"left_nasolabial_wrinkle_list": []
},
"right_nasolabial_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"right_nasolabial_wrinkle_list": []
},
"left_cheek_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"left_cheek_wrinkle_list": []
},
"right_cheek_wrinkle_info": {
"wrinkle_score": 0,
"wrinkle_severity_level": 0,
"wrinkle_norm_length": 0,
"wrinkle_norm_depth": 0,
"wrinkle_pixel_density": 0,
"wrinkle_area_ratio": 0,
"wrinkle_deep_ratio": 0,
"wrinkle_deep_num": 0,
"wrinkle_shallow_num": 0,
"right_cheek_wrinkle_list": []
},
"cheekbone_mark": {
"left_cheekbone_mark": [],
"right_cheekbone_mark": []
},
"eye_pouch": {
"value": 0,
"confidence": 0
},
"eye_pouch_severity": {
"value": 0,
"confidence": 0
},
"left_eye_pouch_rectangle": [],
"right_eye_pouch_rectangle": [],
"dark_circle": {
"value": 0,
"confidence": 0
},
"dark_circle_severity": {
"value": 0,
"confidence": 0
},
"left_dark_circle_rete": {
"value": 0
},
"right_dark_circle_rete": {
"value": 0
},
"left_dark_circle_pigment": {
"value": 0
},
"right_dark_circle_pigment": {
"value": 0
},
"left_dark_circle_structural": {
"value": 0
},
"right_dark_circle_structural": {
"value": 0
},
"dark_circle_mark": {
"left_eye_rect": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
},
"right_eye_rect": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
}
},
"left_eye_pouch_rect": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
},
"right_eye_pouch_rect": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
},
"wrinkle_mark": {
"left_cheek_wrinkle_outline": [],
"right_cheek_wrinkle_outline": [],
"head_wrinkle_outline": [],
"left_nasolabial_wrinkle_outline": [],
"right_nasolabial_wrinkle_outline": [],
"glabella_wrinkle_outline": [],
"left_crowsfeet_wrinkle_outline": [],
"right_crowsfeet_wrinkle_outline": [],
"left_mouth_wrinkle_outline": [],
"right_mouth_wrinkle_outline": [],
"left_eye_wrinkle_outline": [],
"right_eye_wrinkle_outline": []
},
"dark_circle_outline": {
"left_dark_circle_outline": [],
"right_dark_circle_outline": []
},
"score_info": {
"dark_circle_score": 0,
"skin_type_score": 0,
"wrinkle_score": 0,
"oily_intensity_score": 0,
"pores_score": 0,
"blackhead_score": 0,
"acne_score": 0,
"sensitivity_score": 0,
"melanin_score": 0,
"water_score": 0,
"rough_score": 0,
"total_score": 0,
"pores_type_score": {
"pores_forehead_score": 0,
"pores_leftcheek_score": 0,
"pores_rightcheek_score": 0,
"pores_jaw_score": 0
},
"dark_circle_type_score": {
"left_dark_circle_score": 0,
"right_dark_circle_score": 0
}
},
"enhanced_bw_info": {
"enhanced_bw_rect": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
},
"ratio": 0
},
"face_maps": {
"red_area": "",
"brown_area": "",
"texture_enhanced_pores": "",
"texture_enhanced_blackheads": "",
"texture_enhanced_oily_area": "",
"texture_enhanced_lines": "",
"water_area": "",
"rough_area": "",
"roi_outline_map": "",
"texture_enhanced_bw": ""
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/face-analyzer": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "Face Analyzer",
"description": "Face Analyzer API detects facial position, attributes, attractiveness, pose, and quality metrics from portrait images.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"max_face_num": {
"type": "string",
"description": "The maximum number of faces processed. When set to 1, only the largest face in the image is detected. A smaller value leads to faster processing speed."
},
"face_attributes_type": {
"type": "string",
"description": "Whether to return attributes such as age, gender, mood, etc. AttributesInfo is returned for up to 5 faces with the largest area, and AttributesInfo for more than 5 faces (the 6th and later faces) are not referenced."
},
"need_rotate_detection": {
"type": "string",
"description": "Whether to enable image rotation recognition support. When the face in the picture is rotated and there is no exif information in the picture, if you don't turn on the picture rotation recognition support, you can't detect and recognize the face in the picture correctly. If you are sure that the picture contains exif information or you are sure that the face in the input picture will not be rotated, please do not turn on this parameter. If this parameter is turned on, the overall time required may increase by hundreds of milliseconds. `0`: Close. `1`: Open."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image_width": 0,
"image_height": 0,
"face_detail_infos": [
{
"face_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"face_detail_attributes_info": {
"age": 0,
"beauty": 0,
"emotion": {
"type": 0,
"probability": 0
},
"eye": {
"glass": {
"type": 0,
"probability": 0.99936753511429
},
"eye_open": {
"type": 0,
"probability": 0.99949336051941
},
"eyelid_type": {
"type": 1,
"probability": 0.75467920303345
},
"eye_size": {
"type": 2,
"probability": 0.59152442216873
}
},
"eyebrow": {
"eyebrow_density": {
"type": 0,
"probability": 0
},
"eyebrow_curve": {
"type": 0,
"probability": 0
},
"eyebrow_length": {
"type": 0,
"probability": 0
}
},
"gender": {
"type": 0,
"probability": 0
},
"hair": {
"length": {
"type": 0,
"probability": 0
},
"bang": {
"type": 0,
"probability": 0
},
"color": {
"type": 0,
"probability": 0
}
},
"hat": {
"style": {
"type": 0,
"probability": 0
},
"color": {
"type": 0,
"probability": 0
}
},
"head_pose": {
"pitch": 0,
"yaw": 0,
"roll": 0
},
"mask": {
"type": 0,
"probability": 0
},
"mouth": {
"mouth_open": {
"type": 0,
"probability": 0
}
},
"moustache": {
"type": 0,
"probability": 0
},
"nose": {
"type": 2,
"probability": 0.75233882665634
},
"shape": {
"type": 0,
"probability": 0
},
"skin": {
"type": 0,
"probability": 0
},
"smile": 0
}
}
]
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/face-analyzer-advanced": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "Face Analyzer Advanced",
"description": "Face Analyzer Advanced API detects facial attributes and quality metrics, including age, gender, expression, pose, blur, and occlusion.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image_width": 0,
"image_height": 0,
"face_detail_infos": [
{
"face_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"face_detail_attributes_info": {
"age": 0,
"beauty": 0,
"emotion": {
"type": 0,
"probability": 0
},
"eye": {
"glass": {
"type": 0,
"probability": 0.99936753511429
},
"eye_open": {
"type": 0,
"probability": 0.99949336051941
},
"eyelid_type": {
"type": 1,
"probability": 0.75467920303345
},
"eye_size": {
"type": 2,
"probability": 0.59152442216873
}
},
"eyebrow": {
"eyebrow_density": {
"type": 0,
"probability": 0
},
"eyebrow_curve": {
"type": 0,
"probability": 0
},
"eyebrow_length": {
"type": 0,
"probability": 0
}
},
"gender": {
"type": 0,
"probability": 0
},
"hair": {
"length": {
"type": 0,
"probability": 0
},
"bang": {
"type": 0,
"probability": 0
},
"color": {
"type": 0,
"probability": 0
}
},
"hat": {
"style": {
"type": 0,
"probability": 0
},
"color": {
"type": 0,
"probability": 0
}
},
"head_pose": {
"pitch": 0,
"yaw": 0,
"roll": 0
},
"mask": {
"type": 0,
"probability": 0
},
"mouth": {
"mouth_open": {
"type": 0,
"probability": 0
}
},
"moustache": {
"type": 0,
"probability": 0
},
"nose": {
"type": 2,
"probability": 0.75233882665634
},
"shape": {
"type": 0,
"probability": 0
},
"skin": {
"type": 0,
"probability": 0
},
"smile": 0
}
}
]
}
}
},
"description": "Success"
}
}
}
},
"/api/portrait/analysis/ai-face-rating": {
"post": {
"tags": [
"AI PORTRAIT > Portrait Analysis"
],
"summary": "AI Face Rating",
"description": "AI Face Rating API analyzes portraits for beauty score, symmetry, facial proportions, skin impression, and improvement tips.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"aspect_ratio": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"auto",
"1:1",
"3:4",
"4:3",
"9:16",
"16:9"
],
"default": "auto"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/generation/ai-flower-wallpaper": {
"post": {
"tags": [
"AI IMAGE > Image Generation"
],
"summary": "AI Flower Wallpaper",
"description": "AI Flower Wallpaper API turns names into personalized floral wallpapers, bouquet art, and flower-language image designs.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User name to display in the wallpaper (English only).",
"maxLength": 500,
"default": "AUTO"
},
"flower_elements": {
"type": "string",
"description": "Flower elements and bouquet composition description (English only).",
"maxLength": 4000,
"default": "AUTO"
},
"style": {
"type": "string",
"description": "Artwork style for the generated wallpaper (English only).",
"maxLength": 4000,
"default": "soft watercolor floral illustration"
},
"background": {
"type": "string",
"description": "Background style or color theme for the wallpaper (English only).",
"maxLength": 4000,
"default": "pastel gradient background"
},
"aspect_ratio": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"auto",
"1:1",
"3:4",
"4:3",
"9:16",
"16:9"
],
"default": "auto"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/effects/ai-anime-generator": {
"post": {
"tags": [
"AI IMAGE > Image Effects"
],
"summary": "AI Cartoon Generator",
"description": "AI Cartoon Generator API turns photos into cartoon, anime, and stylized illustrations with multiple AI art styles.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"description": "Task Type.",
"example": "async"
},
"image": {
"type": "string",
"format": "binary"
},
"index": {
"type": "string",
"description": "Cartoon effect. `0`: Vintage Comic. `1`: 3D Fairy Tale. `2`: Two-dimensional (2D). `3`: Refreshing and Elegant. `4`: Future Technology. `5`: Traditional Chinese Painting Style. `6`: General in a Hundred Battles. `7`: Colorful Cartoon. `8`: Graceful Chinese Style."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/effects/image-colorization": {
"post": {
"tags": [
"AI IMAGE > Image Effects"
],
"summary": "AI Photo Colorize",
"description": "AI Photo Colorize API converts black-and-white photos into realistic full-color images for restoration and creative projects.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/effects/image-style-conversion": {
"post": {
"tags": [
"AI IMAGE > Image Effects"
],
"summary": "Photo to Painting",
"description": "Photo to Painting API converts photos into cartoon, pencil, oil painting, and other artistic styles with AI.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"option": {
"type": "string",
"description": "`cartoon`: Cartoon style. `pencil`: Pencil style. `color_pencil`: Color pencil drawing style. `warm`: The style of colorful sugar cube oil painting. `wave`: Oil painting style in surfing in Kanagawa. `lavender`: Lavender oil painting style. `mononoke`: Strange oil painting style. `scream`: Scream oil painting style. `gothic`: Gothic oil painting style."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/effects/photo-to-line-art": {
"post": {
"tags": [
"AI IMAGE > Image Effects"
],
"summary": "Photo to Coloring Page",
"description": "Photo to Coloring Page API converts photos into clean line art for printable coloring pages, templates, and creative use.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "Original image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"prompt": {
"type": "string",
"description": "Prompt (English only). Max 3000 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 3000
},
"image_size": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"A4",
"auto",
"1:1",
"2:3",
"3:2",
"3:4",
"4:3",
"4:5",
"5:4",
"9:16",
"16:9",
"21:9"
],
"default": "A4"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/effects/photo-to-emoji-grid": {
"post": {
"tags": [
"AI IMAGE > Image Effects"
],
"summary": "AI Emoji Generator",
"description": "AI Emoji Generator API turns portrait or pet photos into emoji-style grids with consistent expressions and scenes.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"expression",
"style",
"scene"
],
"properties": {
"image": {
"type": "string",
"description": "Original image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"expression": {
"type": "string",
"description": "Expression (English only). Max 100 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 100,
"example": "Angry"
},
"style": {
"type": "string",
"description": "Style (English only). Max 100 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 100,
"example": "3D Emoji Render"
},
"scene": {
"type": "string",
"description": "Scene (English only). Max 100 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 100,
"example": "Baby Shower"
},
"filler": {
"type": "string",
"description": "Filler Text (English only). Max 20 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 20,
"example": "Go Go Go"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/effects/ai-photography": {
"post": {
"tags": [
"AI IMAGE > Image Effects"
],
"summary": "AI Photography",
"description": "AI Photography API creates stylized AI photoshoot images from portraits using prompt-defined scenes and styles.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"style_title",
"style_desc"
],
"properties": {
"image": {
"type": "string",
"description": "Original image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"style_title": {
"type": "string",
"description": "Style name (English only). Max 500 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 500
},
"style_desc": {
"type": "string",
"description": "Style description (English only). Max 1000 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 1000
},
"image_size": {
"type": "string",
"description": "Output Image Aspect Ratio.",
"enum": [
"auto",
"1:1",
"2:3",
"3:2",
"3:4",
"4:3",
"4:5",
"5:4",
"9:16",
"16:9",
"21:9"
],
"default": "auto"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/image-cropping": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "AI Image Cropping",
"description": "AI Image Cropping API detects the main subject and crops images to target dimensions for thumbnails, layouts, and visual assets.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"width": {
"type": "string",
"description": "The width of the target. Unit: px."
},
"height": {
"type": "string",
"description": "The height of the target. Unit: px."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"url": "",
"retain_location": {
"width": 0,
"height": 0,
"y": 0,
"x": 0
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/intelligent-composition": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Intelligent Composition",
"description": "Intelligent Composition API analyzes image aesthetics and returns smart crop boxes for better framing and composition.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"num_boxes": {
"type": "string",
"description": "The number of output boxes."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"elements": [
{
"min_x": 0,
"max_x": 0,
"min_y": 0,
"max_y": 0,
"score": 0
}
]
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/photo-retouching": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Photo Retouch",
"description": "Photo Retouch API transfers the style of a reference image onto a target image for AI-powered image repair and retouching.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Images that require a style transformation.",
"format": "binary"
},
"style": {
"type": "string",
"description": "Reference image.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/image-invisible-image-watermark": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Image Invisible Picture Watermark",
"description": "Image Invisible Picture Watermark API encodes or decodes hidden image and logo watermarks for copyright and asset protection.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"function_type": {
"type": "string",
"description": "Specifies the calling function."
},
"origin_image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"logo": {
"type": "string",
"description": "Watermark images.",
"format": "binary"
},
"output_file_type": {
"type": "string",
"description": "Output format."
},
"watermark_image": {
"type": "string",
"description": "The image to be resolved, i.e. the composite image with the image watermark.",
"format": "binary"
},
"quality_factor": {
"type": "string",
"description": "The quality size of the output image, the higher the quality the larger the image."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "encode_pic|encode_pic_plus|encode_pic_bold",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"watermark_image_url": "",
"logo_url": ""
}
}
},
"example-1": {
"summary": "decode_pic",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"watermark_image_url": "",
"logo_url": ""
}
}
},
"example-2": {
"summary": "decode_pic_plus|decode_pic_bold",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"watermark_image_url": "",
"logo_url": ""
}
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/image-invisible-text-watermarking": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Image Invisible Text Watermark",
"description": "Image Invisible Text Watermark API encodes or decodes hidden text watermarks for image ownership and content protection.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"function_type": {
"type": "string",
"description": "Specifies the calling function."
},
"origin_image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"text": {
"type": "string",
"description": "The text of the watermark to be added."
},
"output_file_type": {
"type": "string",
"description": "Output format."
},
"watermark_image": {
"type": "string",
"description": "The image to be resolved, i.e., a composite image with a text watermark.",
"format": "binary"
},
"quality_factor": {
"type": "string",
"description": "The quality size of the output image, the higher the quality the larger the image."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "encode_text|encode_text_plus|encode_text_bold",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"watermark_image_url": "",
"text_image_url": ""
}
}
},
"example-1": {
"summary": "decode_text",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"watermark_image_url": "",
"text_image_url": ""
}
}
},
"example-2": {
"summary": "decode_text_plus|decode_text_bold",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"watermark_image_url": "",
"text_image_url": ""
}
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/remove-objects": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Remove Objects",
"description": "Remove Objects API deletes unwanted objects, people, or text from images using mask-based AI inpainting.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"mask": {
"type": "string",
"description": "Mask image.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/remove-objects-advanced": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Remove Objects Advanced",
"description": "Remove Objects Advanced API removes masked objects, people, or text from images with more precise AI inpainting results.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"mask": {
"type": "string",
"description": "Mask image.",
"format": "binary"
},
"steps": {
"type": "integer",
"description": "Sampling steps determine the level of detail in the generated image. A higher value may result in better quality, but it will significantly increase the processing time.",
"example": "30"
},
"strength": {
"type": "number",
"description": "The smaller the value, the closer it is to the original image.",
"example": "0.8"
},
"scale": {
"type": "integer",
"description": "The degree to which the text description influences the output.",
"example": "7"
},
"seed": {
"type": "integer",
"description": "Random seed, used as the basis for determining the initial state of the diffusion process. It must be a non-negative number (`-1` represents a random seed). If the random seed is the same positive integer and all other parameters are identical, the generated image will most likely be consistent.",
"example": "0"
},
"dilate_size": {
"type": "integer",
"description": "Mask Dilation Radius. The mask used for object removal should fully encompass the target object. When users manually draw the mask, it often extends beyond the object's boundary. However, if the mask is generated by a segmentation algorithm, it typically adheres closely to the object's edges, which might leave parts of the object uncovered. This can lead to incomplete removal or unexpected artifacts during generation. To avoid such issues, it's recommended to appropriately increase the `dilate_size` parameter to ensure the mask fully covers the object.",
"example": "15"
},
"quality": {
"type": "string",
"description": "Quality Parameter. `H`: High quality — best output quality, but slightly slower processing. `M`: Medium quality — balanced in both quality and speed. `L`: Low quality — fastest processing, suitable for scenarios where speed is prioritized.",
"example": "M"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"binary_data_base64": []
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/remove-objects-pro": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "Remove Objects Pro",
"description": "Remove Objects Pro API removes masked objects, people, or text from images for high-quality cleanup and professional editing.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"mask": {
"type": "string",
"description": "Mask image.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/ai-object-replacer": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "AI Object Replacer",
"description": "AI Object Replacer API removes masked objects and fills the area with prompt-guided content for clean image editing.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"mask": {
"type": "string",
"description": "Mask image.",
"format": "binary"
},
"custom_prompt": {
"type": "string",
"description": "Prompt Content (English only). Please limit the prompt content to 100 English words or fewer. Any content beyond this limit may have minimal impact on the generated result. Use standard vocabulary to avoid failing the review process."
},
"steps": {
"type": "integer",
"description": "Sampling steps determine the level of detail in the generated image. A higher value may result in better quality, but it will significantly increase the processing time.",
"example": "25"
},
"scale": {
"type": "integer",
"description": "The degree to which the text description influences the output.",
"example": "5"
},
"seed": {
"type": "number",
"description": "Random seed, used as the basis for determining the initial state of the diffusion process. It must be a non-negative number (`-1` represents a random seed). If the random seed is the same positive integer and all other parameters are identical, the generated image will most likely be consistent.",
"example": "-1"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"binary_data_base64": []
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/ai-image-extender": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "AI Image Extender",
"description": "AI Image Extender API expands images beyond their original borders using prompts, canvas, frame, or four-side extension modes.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Original image.",
"format": "binary"
},
"mask": {
"type": "string",
"description": "Mask image.",
"format": "binary"
},
"steps": {
"type": "integer",
"description": "Sampling steps determine the level of detail in the generated image. A higher value may result in better quality, but it will significantly increase the processing time.",
"example": "30"
},
"strength": {
"type": "number",
"description": "The smaller the value, the closer it is to the original image.",
"example": "0.8"
},
"scale": {
"type": "integer",
"description": "The degree to which the text description influences the output.",
"example": "7"
},
"seed": {
"type": "integer",
"description": "Random seed, used as the basis for determining the initial state of the diffusion process. It must be a non-negative number (`-1` represents a random seed). If the random seed is the same positive integer and all other parameters are identical, the generated image will most likely be consistent.",
"example": "0"
},
"top": {
"type": "number",
"description": "Upward expansion ratio.",
"example": "0.1"
},
"bottom": {
"type": "number",
"description": "Downward expansion ratio.",
"example": "0.1"
},
"left": {
"type": "number",
"description": "Leftward expansion ratio.",
"example": "0.1"
},
"right": {
"type": "number",
"description": "Rightward expansion ratio.",
"example": "0.1"
},
"max_height": {
"type": "integer",
"description": "Maximum output height. Resized to the specified dimensions as a fallback after the image expansion process.",
"example": "1920"
},
"max_width": {
"type": "integer",
"description": "Maximum output width. Resized to the specified dimensions as a fallback after the image expansion process.",
"example": "1920"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"example-0": {
"summary": "Non-Mask Expanded Image",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"binary_data_base64": []
}
}
},
"example-1": {
"summary": "Mask Expanded Image",
"value": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"binary_data_base64": []
}
}
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/ai-nail-art": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "AI Nail Art",
"description": "AI Nail Art API applies prompt-based nail designs to real nail photos, creating realistic manicure previews for beauty apps.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"nail_name",
"nail_desc"
],
"properties": {
"image": {
"type": "string",
"description": "Original image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"nail_name": {
"type": "string",
"description": "Nail Name (English only). Max 500 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 500,
"example": "Golden Butterfly Glow"
},
"nail_desc": {
"type": "string",
"description": "Nail Description (English only). Max 1000 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.",
"maxLength": 1000,
"example": "Champagne nude shimmer with gold butterfly accents for a soft, luxe finish."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/editing/ai-nail-art-pro": {
"post": {
"tags": [
"AI IMAGE > Image Editing"
],
"summary": "AI Nail Art Pro",
"description": "AI Nail Art Pro API generates reference-guided AI nail designs for salon previews, beauty apps, and production workflows.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image",
"reference_image"
],
"properties": {
"image": {
"type": "string",
"description": "Source image. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"reference_image": {
"type": "string",
"description": "Reference image for guidance. \n- Image format: `JPEG` `JPG` `PNG` `WEBP` \n- Image size: No more than 10 MB. \n- Image resolution: Less than 4096x4096px.",
"format": "binary"
},
"resolution": {
"type": "string",
"description": "Output resolution.",
"enum": [
"1K",
"2K"
],
"default": "1K"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "async",
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/enhance/image-defogging": {
"post": {
"tags": [
"AI IMAGE > Image Enhancement"
],
"summary": "Image Dehaze",
"description": "Image Dehaze API removes haze and fog from photos to restore clarity, contrast, and cleaner image details.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/enhance/image-lossless-enlargement": {
"post": {
"tags": [
"AI IMAGE > Image Enhancement"
],
"summary": "Image Upscaler",
"description": "Image Upscaler API enlarges images 2x to 4x while enhancing detail, reducing noise, and preserving visual quality.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"upscale_factor": {
"type": "string",
"description": "Magnification."
},
"mode": {
"type": "string",
"description": "Image output mode. `base`: Normal mode, i.e. stable super-resolution effect. `enhancement`: Enhancement mode, which has a more prominent enhancement effect than the normal mode, further improving the clarity and sharpness of the output image."
},
"output_format": {
"type": "string",
"description": "Output image format."
},
"output_quality": {
"type": "string",
"description": "Quality factor of the output image, where a higher value corresponds to higher quality. Only applicable when `output_format=jpg`."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"url": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/enhance/stretch-image-recovery": {
"post": {
"tags": [
"AI IMAGE > Image Enhancement"
],
"summary": "Stretched Image Restoration",
"description": "Stretched Image Restoration API detects distorted images and restores natural proportions with AI-powered correction.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image": "",
"ratio": 0
}
}
},
"description": "Success"
}
}
}
},
"/api/image/enhance/image-sharpness-enhancement": {
"post": {
"tags": [
"AI IMAGE > Image Enhancement"
],
"summary": "Image Sharpness Enhancement",
"description": "Image Sharpness Enhancement API deblurs photos and improves edge clarity for sharper, higher-quality images.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/enhance/image-contrast-enhancement": {
"post": {
"tags": [
"AI IMAGE > Image Enhancement"
],
"summary": "Image Contrast Enhancement",
"description": "Image Contrast Enhancement API adjusts contrast and tone to improve clarity, depth, and visual balance in photos.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"image": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/image/enhance/image-color-enhancement": {
"post": {
"tags": [
"AI IMAGE > Image Enhancement"
],
"summary": "Image Color Enhancement",
"description": "Image Color Enhancement API improves photo color, saturation, brightness, and contrast for clearer, more vibrant images.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"output_format": {
"type": "string",
"description": "The format of the output image."
},
"mode": {
"type": "string",
"description": "Color mixing mode. `LogC`: Suitable for gray film (low contrast raw map) input, adjust the image color perception substantially to restore the color texture of the SDR domain. `Rec709`: Suitable for images taken under general conditions, appropriate to enhance the image brightness, saturation, etc., the adjustment range is more conservative. `ln17_256`: Suitable for images taken under general conditions, drastically adjusts image brightness, saturation, contrast, and improves color quality."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/rating/image-composition-aesthetics-scoring": {
"post": {
"tags": [
"AI IMAGE > Image Scoring"
],
"summary": "Image Composition Aesthetics Score",
"description": "Image Composition Aesthetics Score API rates photo composition from 0 to 5 to help select stronger visual layouts.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"score": 0
}
}
}
},
"description": "Success"
}
}
}
},
"/api/image/rating/image-exposure-score": {
"post": {
"tags": [
"AI IMAGE > Image Scoring"
],
"summary": "Image Exposure Score",
"description": "Image Exposure Score API evaluates image exposure from 0 to 1 to identify underexposed or overexposed photos.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"exposure": 0
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/general/universal-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > General"
],
"summary": "Universal Background Removal",
"description": "Universal Background Removal API removes image backgrounds from people, animals, food, and objects for clean subject cutouts.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"return_form": {
"type": "string",
"description": "Specifies the form of the returned image. If not set, the four-channel PNG map is returned. `mask`: Returns a single channel mask. `whiteBK`: Return to white background image. `crop`: Returns the four-channel PNG image after cropping (cropping out the blank areas around the edges)."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/general/hd-universal-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > General"
],
"summary": "HD Universal Background Removal",
"description": "HD Universal Background Removal API removes backgrounds from people, animals, food, and objects with high-definition subject cutouts.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "- Image format: `JPEG` `JPG` `BMP` `PNG` \n- Image size: No more than 40 MB. \n- Image resolution: Larger than 32x32px, smaller than 10000x10000px.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublicResponseFields"
},
{
"type": "object",
"required": [
"task_id"
],
"properties": {
"task_id": {
"$ref": "#/components/schemas/AsyncTaskId"
}
}
}
]
},
"example": {
"request_id": "",
"log_id": "",
"error_detail": {
"code": "",
"code_message": "",
"message": ""
},
"task_id": ""
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/general/food-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > General"
],
"summary": "Food Background Removal",
"description": "Food Background Removal API removes food image backgrounds and isolates dishes for menus, delivery apps, food blogs, and e-commerce.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"return_form": {
"type": "string",
"description": "Specifies the form of the returned image. If not set, the four-channel PNG map is returned. `mask`: Returns a single channel mask. `whiteBK`: Return to white background image."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/general/commodity-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > General"
],
"summary": "Product Background Removal",
"description": "Product Background Removal API removes product backgrounds and isolates items for clean e-commerce images, catalogs, and marketplace listings.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"return_form": {
"type": "string",
"description": "Specifies the form of the returned image. If not set, the four-channel PNG map is returned. `mask`: Returns a single channel mask. `whiteBK`: Return to white background image. `crop`: Returns the four-channel PNG image after cropping (cropping out the blank areas around the edges)."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/general/apparel-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > General"
],
"summary": "Costume Background Removal",
"description": "Costume Background Removal API removes clothing backgrounds and isolates garments for apparel photos, e-commerce listings, and product displays.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"out_mode": {
"type": "string",
"description": "Specifies the type of segmentation result to return, which affects the content of the `image_url` field. `0`: Default segmentation result of the main clothing. `1`: Combined segmentation result based on the category specified by `cloth_class`."
},
"cloth_class": {
"type": "string",
"description": "Clothing categories. Multiple values can be submitted at once, separated by commas (,). `tops`: Tops. `coat`: Coat. `skirt`: Skirt. `pants`: Pants. `bag`: Bag. `shoes`: Shoes. `hat`: Hat."
},
"return_form": {
"type": "string",
"description": "Specify the desired image format for the output. `whiteBK`: Returns an image with a white background. `mask`: Returns a single-channel mask. If not specified, a four-channel PNG image will be returned."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"elements": [
{
"image_url": ""
},
{
"class_url": {
"tops": "",
"coat": "",
"skirt": "",
"pants": "",
"bag": "",
"shoes": "",
"hat": ""
}
}
]
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/portrait/portrait-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > Portrait"
],
"summary": "Human Background Removal",
"description": "Human Background Removal API detects people and removes portrait backgrounds for profile photos, design assets, and e-commerce images.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"return_form": {
"type": "string",
"description": "Specifies the form of the returned image. If not set, the four-channel PNG map is returned. `mask`: Returns a single channel mask. `whiteBK`: Return to white background image. `crop`: Returns the four-channel PNG image after cropping (cropping out the blank areas around the edges)."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"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": ""
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/portrait/hd-portrait-background-removal": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > Portrait"
],
"summary": "HD Human Background Removal",
"description": "HD Human Background Removal API removes portrait backgrounds with high-definition human subject cutouts for photo editing and design.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"elements": [
{
"image_url": ""
}
]
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/portrait/avatar-extraction": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > Portrait"
],
"summary": "Head Extraction",
"description": "Head Extraction API detects and crops head regions from portraits to create clean avatars, profile images, and social media headshots.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"return_form": {
"type": "string",
"description": "Specifies the form of the returned image. If not set, the four-channel PNG map is returned. `mask`: Returns a single channel mask."
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"elements": [
{
"image_url": "",
"width": 0,
"height": 0,
"x": 0,
"y": 0
}
]
}
}
}
},
"description": "Success"
}
}
}
},
"/api/cutout/portrait/hairstyle-extraction": {
"post": {
"tags": [
"AI BACKGROUND REMOVAL > Portrait"
],
"summary": "Hairstyle Extraction",
"description": "Hairstyle Extraction API extracts hairstyle regions from portrait images and returns the extracted hairstyle result.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"elements": [
{
"image_url": "",
"width": 0,
"height": 0,
"x": 0,
"y": 0
}
]
}
}
}
},
"description": "Success"
}
}
}
}
}
}