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

get

List aux images for image

Authorizations

PrivateTokenAuthPasswordAuthcookieAuth

AuthorizationstringRequired

Authenticate using SaaS Private token

Path parameters

company_idstring · uuidRequired

image_idstring · uuidRequired

Query parameters

expiration_secondsintegerOptional

expiration seconds for signed url

Default: 60

algo_appstringOptional

aux_image_typestringOptionalDefault: restored

Responses

200Success

application/json

idstring · uuidRequired

aux_image_typestringRequired

creation_timestring · date-timeOptional

algo_appstringRequired

signed_urlstring · nullableRead-onlyRequired

metaone ofOptional

anyOptional

or

nullOptional

get

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

HTTPcURLJavaScriptPython

GET /api/v1/companies/{company_id}/images/{image_id}/aux_images/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "aux_image_type": "text",
    "creation_time": "2026-03-02T18:33:28.372Z",
    "algo_app": "text",
    "signed_url": null,
    "meta": null
  }
]

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

• algo_app — filter by application name which generated this aux image (e.g. Face Skin Metrics 2.0). It implements case insensitive sub-string 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 sub-string search, so if you need only 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 response 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.