Face Application

The Face application API returns results of the face image quality algorithm and facial skin parameters.

Skin parameters

Base URL

HTTPS: https://saas.haut.ai/api/v1/companies/{company_id}/datasets/{dataset_id}/subjects/{subject_id}/batches/{batch_id}/images/{image_id}/results/

Supported Methods: GET

Request Parameters

Required Parameters

Description

Type

company_id

string

dataset_id

string

subject_id

string

batch_id

string

image_id

string

Query Parameters

Required Parameters

Description

Type

token

string

application_run_id

string

application_name

string

application_id

string

Example Response (JSON):

[{ 
 "id":"d4848915-7206-4f06-a3f6-843ca9e73389", 
 "result":41.0,"is_ok":true, 
 "image_id":"2220a9ae-a748-426a-a48c-d5e773e09575", 
 "algorithm_version_id":23, 
 "creation_time":"2021-03-01 15:33:00", 
 "application_id":"d2942e17-6239-49d1-8ff5-d74c4eb0bd20", 
 "application_name":"Face Skin Metrics", 
 "application_description":"Calculates face and skin metrics.", 
 "application_run_id":"b22a2bba-294e-49fa-8412-7de9526132b1" 
 }, 
{ 
"id":"7117c34f-f3f8-44ae-96f1-6108fcd62c7c", 
"result":37.0,"is_ok":true, 
"image_id":"2220a9ae-a748-426a-a48c-d5e773e09575", 
"algorithm_version_id":19, 
"creation_time":"2021-03-01 15:33:00", 
"application_id":"d2942e17-6239-49d1-8ff5-d74c4eb0bd20", 
"application_name":"Face Skin Metrics", 
"application_description":"Calculates face and skin metrics.", 
"application_run_id":"b22a2bba-294e-49fa-8412-7de9526132b1" 
}]

Field description:

id

Id

string <uuid>

result

algorithm result data

object (Result)

is_ok

algorithm result error status

boolean (Is ok)

image_id

algorithm result image id

string <uuid> (Image id)

algorithm_version_id

algorithm result algo version

integer (Algorithm version id)

creation_time

Creation time

string <date-time>

application_id

Application id

string <uuid>

application_name

Application name

string

application_description

Application description

string

application_run_id

Application run id

string

Description of algorithm_version_id and result

The following table contains information about algorithm_version_id and the corresponding result. The result can be used to classify parameter values.

name

description

result

result classification

15

Skin redness

Our skin has a natural pink colour because of blood vessels. Increased skin Redness can be associated with allergic reactions, inflammatory processes. The most common environmental factors leading to facial redness are cold air or ultraviolet radiation. Higher skin redness level is associated with a higher value for this parameter.

float

(70,100] - Bad (50,70] - Rather bad (30,50] - Average (20,30] - Good (10,20] - Great [0,10] - Excellent

17

Skin uniformness

The Uniformness metric shows how smooth and even your skin is. It takes into account eruption, age spots, freckles, and blood vessels close to the surface, along with texture associate skin features. The higher is the value of this parameter, the more uniform and smooth skin you have.

float

(90,100] - Excellent (80,90] - Great (70,80] - Good (50,70] - Average (30,50] - Rather bad [0,30] - Bad

24

Skintone ITA degree

Skintone shows how tanned your skin is. Many pigments have an effect on the color of the skin. One of the most important factors affecting skintone is the quantity of melanin the skin contains. The amount of melanin in the skin is determined by genetic factors, but it is also increased by the impact of the sun’s radiation. To determine overall pigmentation or skin color, the ITA° system was developed. The lighter the skin, the higher the ITA°. ITA values are associated with 6 classes of skin tanning: very light, light, intermediate, tan, brown, dark.

float

(55,90] - very light (41,55] - light (28,41] - intermediate (-10,28] - tan (-30,10] - brown [-90,-30] - dark

19

Eye bags

Eye bags are formed because of the loss of skin elasticity of lower eyelid. Eye bags progression is associated with the aging process, but it can be a sign of lack of sleep or stagnation of blood in vessels under the skin in case of circulatory disorders. The higher the value of this parameter is associated with more prominent eye bags.

float

(70,100] - Bad (50,70] - Rather bad (30,50] - Average (20,30] - Good (10,20] - Great [0,10] - Excellent

20

Wrinkles

Wrinkles are a sign of the ageing process. As we age and under the influence of adverse environmental factors, the content of collagen and hyaluronic acid decreases and the skin loses its elasticity and moisture. These changes lead to the development of wrinkles and their higher prominence over time. The higher is the value of this parameter, the more wrinkles you have.

float

(70,100] - Bad (50,70] - Rather bad (30,50] - Average (20,30] - Good (10,20] - Great [0,10] - Excellent

16

Perceived age

Age can convey important social meanings to the self and others. Perceived age reflects how old you look based on overall face look and skin condition.

float

23

Eyes age

This metric is predicted based on the part of our face, which is most prone to the aging process - areas around the eyes. Eye age reflects the aging pace.

float

97

Pores

Example:

1{"face": 2 {"score":23.0, 3 "pores_density":0.7708478253541672, 4 "number_of_pores":259 5 }, 6 "nose": 7 {"score":23.0, 8 "pores_density":null, 9 "number_of_pores":null 10 }, 11 "left_cheek": 12 {"score":40.0, 13 "pores_density":null, 14 "number_of_pores":null 15 }, 16 "right_cheek": 17 {"score":44.0, 18 "pores_density":null, 19 "number_of_pores":null}, 20 "forehead_n_bridge": 21 {"score":6.0, 22 "pores_density":null, 23 "number_of_pores":null 24 } 25 }

score (float) - pores score range from 0 to 100 pores_density (float) - density of big pores ranges from 0 to 1 is not equal to null for “face“ only number_of_pores (int) - number of big pores, is not equal to null for “face“ only

(70,100] - Bad (50,70] - Rather bad (30,50] - Average (20,30] - Good (10,20] - Great [0,10] - Excellent

Auxillary parameters and skin masks

Base URL

HTTPS: https://saas.haut.ai/api/v1/companies/{company_id}/datasets/{dataset_id}/subjects/{subject_id}/batches/{batch_id}/images/{image_id}/aux/

Supported Methods: GET

Request Parameters

Required Parameters

Description

Type

company_id

string

dataset_id

string

subject_id

string

batch_id

string

image_id

string

Query Parameters

Required Parameters

Description

Type

token

string

application_run_id

string

application_name

string

application_id

string

Example Response (JSON):

{ 
 "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", 
 "aux_image_type": { 
 "id": 0, 
 "name": "string", 
 "tech_name": "string" 
 }, 
 "creation_time": "2019-08-24T14:15:22Z", 
 "results": [ 
 { 
 "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", 
 "result": {}, 
 "is_ok": true, 
 "image_id": "84c230fd-5520-4984-8119-37365b66fd80", 
 "algorithm_version_id": 0, 
 "creation_time": "2019-08-24T14:15:22Z", 
 "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c", 
 "application_name": "string", 
 "application_description": "string", 
 "application_run_id": "53c0c6ed-e767-49c4-ad7c-b1a749bf7dfe" 
 } 
 ], 
 "application_id": "string", 
 "application_name": "string", 
 "application_run_id": "53c0c6ed-e767-49c4-ad7c-b1a749bf7dfe", 
 "application_description": "string" 
}

Description of aux_image_type:

aux_image_type is a type of an auxiliary image that represents facial area:

id

name

tech_name

description

6

Right Eye Extended

right_eye_extended

the algorithm returns result for a Right Eye

7

Left Eye Extended

left_eye_extended

the algorithm returns result for a Left Eye

3

Forehead Center Square

forehead_center_square

the algorithm returns result for a Forehead Center

2

Forehead Right Square

forehead_right_square

the algorithm returns result for a right part of Forehead

4

Right Cheek Square

right_cheek_square

the algorithm returns result for a Left Cheek

29

Face Pores Mask

face_pores

the algorithm returns a mask/map of pores

8

Face Wrinkles Mask

face_wrinkles

the algorithm returns a mask/map of wrinkles

9

Face Eyes Bags Mask

face_eyes_bags

the algorithm returns a mask/map of eye bags

1

Forehead Left Square

forehead_left_square

the algorithm returns result for a left part of Forehead

11

Left Eye Corner

left_eye_corner

the algorithm returns result for a Left Eye corner

5

Left Cheek Square

left_cheek_square

the algorithm returns result for a Left Cheek

13

Right Eye Corner

right_eye_corner

the algorithm returns result for a Right Eye corner

Description of results:

id

Id

string <uuid>

result

algorithm result data

object (Result)

is_ok

algorithm result error status

boolean (Is ok)

image_id

algorithm result image id

string <uuid> (Image id)

algorithm_version_id

algorithm result algo version

integer (Algorithm version id)

creation_time

Creation time

string <date-time>

application_id

Application id

string <uuid>

application_name

Application name

string

application_description

Application description

string

application_run_id

Application run id

string

Description of algorithm_version_id and result:

the same as here

Last updated