For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integrate Haut.AI Image Analysis with Your App

The steps needed to integrate Haut.AI image analysis into your Custom App.

About Image Analysis

Algorithms are an AI core functionality of Haut.AI products. Algorithms enable AI image analysis. You can read more about each application here: Algorithms

For face skin use cases, use Face Skin Analysis 3.0 and its API reference: API for Face Skin Analysis 3.0.


Create Subject in SaaS (repeat this for every unique end-user)

To upload Images, you need to create a Subject. SaaS Subject is a representation of a unique end-user (person) that uses your application, powered by Haut.AI technology, e.g., one of your customers or one of your study participants.

Check the Subjects feature description to know more about Subjects.

Check the Subjects API Overview for details about the relevant methods.

  • The only required key for subject creation is name.

  • The Subject is always stored in the Dataset.


Upload Image to SaaS

When the Subject is created successfully, you can upload Images to it.

Check the API for Images for details about upload, compute, batch status, and results methods.

The Face Skin Analysis 3.0 flow is batch-based:

  1. Initiate image upload for the Subject.

  2. Upload the image file or files to the signed storage URL returned by the API.

  3. Save the image_batch_id.

  4. Send the image batch to computation by calling the compute method.

  5. Receive results by webhook or fetch them for the completed batch.

Face Skin Analysis 3.0 supports a single frontal portrait image and a Face 180 triplet with front, right, and left portrait images. Use LIQA for standardized image collection.

FAQ about images

When will Algorithms process my Image?

Image is sent to Algorithms only if the Subject's Dataset has attached at least 1 Algorithms Application. If no Algorithms are attached to Dataset of the Subject, the Image will be simply stored in the Dataset without being processed.

If I attach the Algorithm Application after the image upload, will it process all previously uploaded images?

Unfortunately, no. Haut.AI services currently do not support the function for retrospective image analysis. Only images uploaded after the Algorithm Application is attached are processed with this Application.


Receive Metrics and Submetrics from SaaS to Your App Server

Metrics and Submetrics are the results of image analysis performed by one or more of Algorithms on the uploaded image batch.

Check the description of the Algorithm Results for more details.

Check the API for Face Skin Analysis 3.0 and API for Images for details about relevant methods.

After you upload your image batch and call the /compute/ method, algorithm processing begins. Once calculation is complete, you can receive results by Webhook or fetch them with the batch results API.

For Face Skin Analysis 3.0, results are returned under the face_skin_analysis_3 object:

Your app should expect:

  • face_skin_analysis_3.parameters as an object keyed by parameter name.

  • all_algorithms_calculated to indicate whether all enabled algorithms finished for the batch.

  • predicted_images to contain signed URLs for generated image variants such as original, aligned_face, and anonymised.

  • Per-parameter errors values for available sides (front, left, right).

Receive Masks

Masks are additional results of image analysis, representing the spatial information about detected skin/hair health returned by the selected set of Algorithms.

Check the API for Masks for details about retrieving Face Skin Analysis 3.0 masks.

In Face Skin Analysis 3.0, masks are returned as signed SVG URLs inside specific parameters:

Use the mask URL that matches the image variant you display. For example, overlay masks.front.aligned_face on top of predicted_images.front.aligned_face.


Receive Smoothed Metrics

Some Algorithms' Metrics vary naturally across images, because skin and image quality both vary. Haut.AI marks the Algorithms that show higher variability with a disclaimer — see Face Metrics 2.0 for an example.

If your application has returning users who submit photos daily, weekly, or monthly, historical Metrics Smoothing may help. Smoothing adjusts the numerical value of each new result using previous analyses of the same Subject.

To fetch smoothed values, see API for Metrics and Submetrics.

Design a Fallback in Your App for Algorithm Processing Errors

It is important to prepare your app to navigate end-users correctly if Haut.AI services can not process an image batch or a specific parameter.

For Face Skin Analysis 3.0, handle two levels of issues:

  1. Image quality issues: use the Quality parameter to decide whether the user should retake the photo.

  2. Individual parameter issues: use each parameter's errors object to decide whether a specific metric can be shown.

Example Quality result:

How to deal with errors

If quality flags such as has_face, has_good_resolution, has_good_exposure, has_no_blur, or has_uniform_illumination are not acceptable for your app, kindly ask the user to retake the photo with clearer positioning, stronger lighting, or fewer obstructions.

If only an individual parameter contains an error, do not block the whole experience. Hide that metric, show a neutral explanation, and continue displaying the rest of the successfully calculated results.


Next Steps

Follow our next guide Create the Best End-User Experience for Image Collection in Your App to learn how to:

  • Integrate smart camera experience for high-quality image collection.

  • Handle image collection for laptop/desktop users to ensure the high quality of the analysis.


Book a demo external-linkPlatform overview on haut.ai

Last updated