🟢API for Aux Images

Description of aux images management via API.

An Aux image is an image that is generated by algorithms and contains specific information extracted from the original image.

The most used aux image is restored selfie front face RGBA image. Which is a standardized image extracted from original selfie. It is a centered, rotated face image extracted from original selfie.

What can you do?

• List aux images for image

• Extract aux images from subject's images list

• Extract aux images from image info

List aux images for image

List aux images for image

List aux images for image

GET/api/v1/companies/{company_id}/images/{image_id}/aux_images/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

image_id*string (uuid)

Query parameters

Response

200

Body

application/json

id*string (uuid)

aux_image_type*string

creation_timestring (date-time)

algo_app*string

signed_url*stringnull

metaone of

anynull

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/images/{image_id}/aux_images/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "aux_image_type": "text",
    "creation_time": "2024-10-22T10:30:27.469Z",
    "algo_app": "text"
  }
]

This method returns all generated aux images for selected image. You can apply additional filters:

• algo_app — filter by application name which generated thix aux image (e.g. Face Skin Metrics 2.0). It implements case insensitive containg search, so if you need only Face Skin Metrics 2.0 related aux images, you can simply use a word face.

• aux_image_type — filter by aux image type tech name (e.g. selfie_front_face_restored_rgba`). It implements case insensitive containg search, so if you need onlt restored aux images, you can simply use a word restored.

---

Extract aux images from subject's images list

If you use this method (link), you can see that each image record returned in API reponse already contains aux images in it. Only drawback is that you can't filter aux images by app or type here.

---

Extract aux images from image info

If you use this method (link), you can see that image record returned in API response already contains aux images in it. Only drawback is that you can't filter aux images by app or type here.