AI Face Rating API

AI Face Rating

curl --request POST \
  --url https://www.ailabapi.com/api/portrait/analysis/ai-face-rating \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image=@example-file \
  --form output_language=en-US

import requests

url = "https://www.ailabapi.com/api/portrait/analysis/ai-face-rating"

files = { "image": ("example-file", open("example-file", "rb")) }
payload = { "output_language": "en-US" }
headers = {"ailabapi-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('image', '<string>');
form.append('output_language', 'en-US');

const options = {method: 'POST', headers: {'ailabapi-api-key': '<api-key>'}};

options.body = form;

fetch('https://www.ailabapi.com/api/portrait/analysis/ai-face-rating', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ailabapi.com/api/portrait/analysis/ai-face-rating",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "ailabapi-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ailabapi.com/api/portrait/analysis/ai-face-rating"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ailabapi-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.ailabapi.com/api/portrait/analysis/ai-face-rating")
  .header("ailabapi-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ailabapi.com/api/portrait/analysis/ai-face-rating")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ailabapi-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "request_id": "",
  "log_id": "",
  "error_detail": {
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_id": ""
}

POST

api

portrait

analysis

ai-face-rating

AI Face Rating

curl --request POST \
  --url https://www.ailabapi.com/api/portrait/analysis/ai-face-rating \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image=@example-file \
  --form output_language=en-US

import requests

url = "https://www.ailabapi.com/api/portrait/analysis/ai-face-rating"

files = { "image": ("example-file", open("example-file", "rb")) }
payload = { "output_language": "en-US" }
headers = {"ailabapi-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('image', '<string>');
form.append('output_language', 'en-US');

const options = {method: 'POST', headers: {'ailabapi-api-key': '<api-key>'}};

options.body = form;

fetch('https://www.ailabapi.com/api/portrait/analysis/ai-face-rating', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ailabapi.com/api/portrait/analysis/ai-face-rating",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "ailabapi-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ailabapi.com/api/portrait/analysis/ai-face-rating"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ailabapi-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.ailabapi.com/api/portrait/analysis/ai-face-rating")
  .header("ailabapi-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ailabapi.com/api/portrait/analysis/ai-face-rating")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ailabapi-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_language\"\r\n\r\nen-US\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "request_id": "",
  "log_id": "",
  "error_detail": {
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_id": ""
}

Query Task

This is an asynchronous task API. The submission request returns only task_id.Use task_id to call Querying Async Task Results and retrieve the final result. Async task results remain available for 24 hours. Query every 5 seconds.

Field	Type	Scope	Description
`data`	`object`		Final result data.
+`result_urls`	`array`		Result image URLs.
++`result_urls[]`	`string`		Result image URL.
+`analysis_result`	`object`		Analysis output.
++`face_symmetry_score`	`integer`	[0, 100]	Face symmetry score.
++`face_shape_score`	`integer`	[0, 100]	Face shape score.
++`facial_proportion_score`	`integer`	[0, 100]	Facial proportion score.
++`skin_impression_score`	`integer`	[0, 100]	Skin impression score.
++`style_impression_score`	`integer`	[0, 100]	Style impression score.
++`overall_score`	`integer`	[0, 100]	Overall score.
++`face_symmetry_comment`	`string`		Face symmetry comment.
++`face_shape_comment`	`string`		Face shape comment.
++`facial_proportion_comment`	`string`		Facial proportion comment.
++`skin_impression_comment`	`string`		Skin impression comment.
++`style_impression_comment`	`string`		Style impression comment.
++`overall_comment`	`string`		Overall comment.
++`style_tags`	`array`		Style tags.
+++`style_tags[]`	`string`
++`visible_face_issues`	`array`		Face issues.
+++`visible_face_issues[]`	`object`
++++`issue`	`string`		Issue description.
++++`severity`	`string`	`low`, `medium`, `high`	Severity. `low`: Low; `medium`: Medium; `high`: High.
++`visible_skin_issues`	`array`		Skin issues.
+++`visible_skin_issues[]`	`object`
++++`issue`	`string`		Issue description.
++++`severity`	`string`	`low`, `medium`, `high`	Severity. `low`: Low; `medium`: Medium; `high`: High.
++`improvement_suggestions`	`array`		Suggestions.
+++`improvement_suggestions[]`	`object`
++++`suggestion`	`string`		Suggestion.
++++`area`	`string`		Area.

{
  "data": {
    "result_urls": [""],
    "analysis_result": {
      "face_symmetry_score": 0,
      "face_shape_score": 0,
      "facial_proportion_score": 0,
      "skin_impression_score": 0,
      "style_impression_score": 0,
      "overall_score": 0,
      "face_symmetry_comment": "",
      "face_shape_comment": "",
      "facial_proportion_comment": "",
      "skin_impression_comment": "",
      "style_impression_comment": "",
      "overall_comment": "",
      "style_tags": [""],
      "visible_face_issues": [
        {
          "issue": "",
          "severity": ""
        }
      ],
      "visible_skin_issues": [
        {
          "issue": "",
          "severity": ""
        }
      ],
      "improvement_suggestions": [
        {
          "suggestion": "",
          "area": ""
        }
      ]
    }
  }
}

All result URLs are temporarily available and will expire after 24 hours.

Submit Task

Authorizations

ailabapi-api-key

string

header

required

API Key for authentication

Body

multipart/form-data

image

file

required

Image format: JPEG JPG PNG WEBP
Image size: No more than 10 MB.
Image resolution: Less than 4096x4096px.

output_language

enum<string>

default:en-US

Specifies the language of the output results.

de-DE: Deutsch.
en-US: English.
es-ES: Español.
fr-FR: Français.
ja-JP: 日本語.
ko-KR: 한국어.
ru-RU: Русский.
zh-CN: 简体中文.
zh-TW: 繁體中文.

Available options:

de-DE,

en-US,

es-ES,

fr-FR,

ja-JP,

ko-KR,

ru-RU,

zh-CN,

zh-TW

Response

200 - application/json

Success

request_id

string

required

Request ID for debugging.

log_id

string

required

Log ID for debugging.

error_detail

object

required

Show child attributes

task_id

string

Task ID for querying Querying Async Task Results.

Preface

Quick Start

AI Common

AI Portrait

AI Image

AI Background Removal

Query Task

Submit Task

Authorizations

Body

Response

​Query Task

​Submit Task

Authorizations

Body

Response

Query Task

Submit Task