API for Face Metrics 2.0 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

List of algorithms

1. Acne

2. Eye age

3. Eye are condition

4. Hydration

5. Lines

6. Perceived age

7. Pigmentation

8. Pores

9. Redness

10. Skintone

11. Skin type

12. Uniformness

13. Image Quality

14. Facial hair attributes

15. Facial landmarks

Auxiliary 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