Skip to content

AI Hair Type Detection

Overview

Imagine having an AI hair expert in your pocket. Our tech dives into your hair's texture, thickness, and curl pattern, picking from ten unique curl shapes and sorting them into nine clear types, from Straight to Super Kinky. You get a full hair profile, and brands can use those insights to deliver spot-on product recommendations and tips just for you.

Integration Guide

  • How to Take Photos for AI Hair Type Detection

  • Take 3 Photos from left, front facing to right.

    • Just snap three quick selfies. One facing straight ahead, one turning about 45 degrees to the left, and one turning 45 degrees to the right. We're trying to catch the full look of your hair from all sides. Make sure your whole face and the upper boundary of your hair are clearly visible in each photo. Your face should take up around 50% to 80% of the image width. Not too small, not too close. That way, it's sharp enough for analysis. When you turn for the side shots, rotate your head left and right like you're saying 'no' (that's called yaw rotation). Keep your head level with no tilting up, down, or sideways. Skip any back or top-down angles because those wont work for us.
    • You can utilize the JS Camera Kit to snap photos. Make sure your hair is not tied up and let it hang in front of your chest. Turn your head to the right and hold still, and turn to the left to get 3 images to be analyzed.
  • How to Detect Hair Type by AI

  • Using the /s2s/v2.0/file API, please upload the following assets:

    • Photos from the front, the right side, and the left side.
  • Execute AI task /s2s/v2.0/task/hair-type-detection
    Run the hair-type detection task by sending in three images: one from the front, one from the right side, and one from the left side. Use their file IDs as the source inputs for the AI.

  • Polling to check the status of a task until it succeed or error
    This task_id is used to monitor the task's status through polling GET 'task/hair-type-detection' to retrieve the current engine status. Until the engine completes the task, the status will remain 'running', and no units will be consumed during this stage.

Hair Type Classification

CategoryThumbnailHair Type ClassificationDescription
1StraightThis hair type is characterized by strands that lack natural curls and typically fall straight from the root to the tip
2ASlight WavyThis hair type features subtle, delicate waves with a smooth and tousled texture, but lacks volume at the roots
2BMedium WavyThis hair type that showcases natural S-shaped waves that typically begin in the middle of the hair shaft and delicately hug the head, creating a subtle and sophisticated dimension
2CThick WavyThe waves in this hair type are characterized by a coarse texture and are shaped like the letter "S", starting at the root and continuing down the length of the hair. This hair type is prone to frizz
3ALoose CurlsThese curls are big, relaxed, and bouncy, and have a noticeable sheen from roots to ends
3BMedium CurlsThis hair type consists of coarse, springy ringlets that are prone to frizz
3CTight CurlsThese curls boast a dense and compact corkscrew shape, lending them plenty of volume
4AKinky SoftThis hair type is characterized by tightly packed, springy S-shaped coils
4BCoilyDensely packed coils tightly wound into sharp, zigzag angles
4CExtremely CoilyThis hair type is characterized by tight, fluffy coils that are more susceptible to breakage
  • Result Arguments

  • mapping: result is a string showing the detected hair type category. Here lists all the possible result strings in an array:

    ["1 to 2a", "2a to 2b", "2b to 2c", "2c to 3a", "3a to 3b", "3b to 3c", "3c to 4a", "4a to 4b", "4b to 4c"]
  • term: a one-to-one mapping string between hair type categories and their classifications. Here lists all the possible result strings in an array:

    ["Straight to Slight Wavy", "Slight to Medium Wavy", "Medium to Thick Wavy", "Thick Wavy to Loose Curls", "Loose to Medium Curls", "Medium to Tight Curls", "Tight Curls to Kinky Soft", "Kinky Soft to Coily", "Coily to Extremely Coily"]
  • Suggestions for How to Shoot Suggestions for How to Shoot

File Specs & Errors

  • Supported Formats & Dimensions
TypeSupported DimensionsSupported File SizeSupported Formats
AI Hair Type DetectionThe image must be at least 320 pixels wide and tall, and no more than 4096 pixels in either dimension. If one side of your image is longer than 1080 pixels, it will be resized automatically to fit within that limit for analysis.< 10MBjpg/png
  • Error Codes
Error CodeDescription
error_mismatch_image_sizeMake sure all your face photos (front, left, and right) are the same size
error_below_min_image_sizeIf your image is smaller than 320 pixels in width or height, it's too small to use
error_face_position_invalidYour face needs to be fully visible in the image, without any parts cut off
error_face_position_too_smallThe face in your photo is too small to analyze properly
error_face_position_out_of_boundaryYour face is either too large or partially outside the edges of the photo
error_insufficient_lightingThe lighting is too dim, which makes analysis difficult
error_face_angle_invalidYour face angle isn't quite right. For front-facing shots, keep your head within 10 degrees of straight. For side-facing shots, the angle should be more than 15 degrees
  • Environment & Dependency
Sample Code Language / ToolRecommended Runtime Versions
cURL- bash >= 3.2
- curl >= 7.58 (modern TLS/HTTP support)
- jq >= 1.6 (robust JSON parsing)
Node.js (JavaScript)Node >= 18 (for global fetch)
JavaScript- Chrome / Edge >= 80
- Firefox >= 74
- Safari >= 13.1
PHPPHP >= 7.4 (for modern TLS/compat), ext-curl (recommended) or allow_url_fopen=On + ext-openssl, ext-json
PythonPython >= 3.10 (for f-strings), requests >= 2.20.0
JavaJava 11+ (for HttpClient), Jackson Databind >= 2.12.0

JS Camera Kit

JavaScript Camera Kit SDK Documentation

version: v2.5

Overview

The JavaScript Camera Kit provides a complete in-browser camera solution designed for high-accuracy face-based imaging tasks. It handles camera permissions, real-time face detection, automatic quality validation (lighting, pose, angle, distance), and guided capture UI flows.

This module is optimized for AI-driven image analysis, such as:

  • AI Skin Analysis (SD/HD)
  • AI Face Tone Analysis
  • Hair-related Analysis
  • Virtual Try-On (Ring, Wrist, Necklace, etc.)

Key Features

  • Permission Handling: Automatic management of webcam access.
  • Quality Validation: Real-time monitoring of face position, lighting, and angle.
  • Multi-Step Flows: Support for complex capture requirements (e.g., multi-angle hair capture).
  • Flexible Output: Supports both base64 and blob image formats.

Installation

Include the SDK via CDN in your HTML <head> or before the closing <body> tag. Once loaded, the SDK installs a global YMK object.

<script src="https://plugins-media.makeupar.com/v2.5-camera-kit/sdk.js"></script>

Quick Start Example

The following example demonstrates how to initialize the kit, open the camera, and handle captured images.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Camera Kit Sample</title>
    <style>
      #YMK-module { margin: 20px 0; }
      img { width: 150px; margin: 5px; border: 1px solid #ccc; }
    </style>
  </head>
  <body>

    <!-- Initialization Script -->
    <script>
      // Define async init entry point
      window.YMKAsyncInit = function() {
        YMK.addEventListener('loaded', function() {
          console.log('Module fully loaded and ready');
        });

        YMK.addEventListener('faceDetectionCaptured', function(capturedResult) {
          const container = document.getElementById('captured-results');
          container.innerHTML = '';

          // Handle multiple images if returned (e.g., multi-angle capture)
          for (const item of capturedResult.images) {
            const img = document.createElement('img');
            // Handle both base64 strings and Blob objects
            img.src = typeof item.image === 'string' 
              ? item.image 
              : URL.createObjectURL(item.image);
            container.appendChild(img);
          }
        });
      };

      function openCameraKit() {
        YMK.init({
          faceDetectionMode: 'makeup',
          imageFormat: 'base64',
          language: 'enu'
        });
        YMK.openCameraKit();
      }
    </script>

    <!-- Load SDK -->
    <script src="https://plugins-media.makeupar.com/v2.5-camera-kit/sdk.js"></script>

    <!-- UI Elements -->
    <button onclick="openCameraKit()">Open Camera Kit</button>

    <!-- Mandatory Mount Point -->
    <div id="YMK-module"></div>

    <h3>Captured Results:</h3>
    <div id="captured-results"></div>
  </body>
</html>

Prerequisites

To ensure successful integration, the following requirements must be met:

RequirementDescription
Browser SupportMust support getUserMedia API.
HTTPSRequired on most browsers for webcam access (except localhost).
Mount PointA <div id="YMK-module"></div> is mandatory for rendering the UI.
Async InitYou must define window.YMKAsyncInit before the SDK loads.

Integration Guide

Step 1: Initialize the Module

Call YMK.init() before calling YMK.openCameraKit().

YMK.init({
  faceDetectionMode: 'makeup', // Detection flow
  imageFormat: 'base64',       // Output format
  language: 'enu'              // UI Language
});

Step 2: Add Event Handlers

Register listeners for camera events and capture results.

YMK.addEventListener('faceQualityChanged', function(q) {
  console.log('Quality updated:', q);
});

Step 3: Open Camera Kit

This displays the UI, opens the webcam, and begins real-time monitoring.

YMK.openCameraKit();

Step 4: Receive Captured Results

Images arrive via the faceDetectionCaptured event.

YMK.addEventListener('faceDetectionCaptured', function(result) {
  console.log(result.images);
});

Step 5: Close Module

Clean up resources when done.

YMK.close();

API Reference

YMK.init(args)

Configures module appearance, detection mode, language, and capture format.

ArgumentTypeDescriptionDefault
faceDetectionModestringDetection flow to use (see Detection Modes below)."skincare"
widthnumberPixel width of module container (300–1920).360 (≥500px) or screen width
heightnumberPixel height of module container (300–1920).480 (≥500px) or min(screen.height, innerHeight)
languagestringUI Language code (chs, cht, deu, enu, esp, fra, jpn, kor, ptb, ita)."enu"
imageFormatstringFormat returned via faceDetectionCaptured."base64"
disableCameraResolutionCheckbooleanAllow running even if webcam does not meet required resolution.false
hideFlipCameraButtonbooleanControls visibility of the flip front/back camera button if the device supports it.false
countingDurationnumberControls the countdown milliseconds when camera quality check meets criteria before auto-capture.800
qualityLevelstringControls the camera quality check setting, with options of relaxed, moderate, or strict.relaxed
qualityOverridesobjectConfigure detailed parameters for camera quality verification.See Camera Kit Quality Configuration
videoQualitystringConfigure the output quality to 720p, 1080p, or 1920p. 720p corresponds to 1280 × 720, 1080p to 1920 × 1080, and 1920p to 2560 × 1920. This setting is supported only for skincare and hdskincare720p

Methods

MethodDescription
YMK.openCameraKit()Opens the module and begins detection.
YMK.close()Closes module and camera.
YMK.addEventListener(event, callback)Registers event callbacks. Returns an EventListenerIdentifier.
YMK.removeEventListener(id)Removes listener by identifier.
YMK.isLoaded()Returns whether livestream or photo is drawn on canvas (boolean).
YMK.pause()Pauses the webcam stream.
YMK.resume(restartWebcam)Resumes webcam after pause.
YMK.getInfo()Returns current module info (e.g., { fps: 30 }).

Camera Kit Quality Configuration

Camera Kit provides configurable quality parameters to control face detection and skin analysis behavior. These parameters allow developers to fine-tune detection strictness while maintaining consistency across web and native SDK implementations.

To simplify configuration, Camera Kit includes three predefined presets:

  • RELAXED: Optimized for usability with minimal restrictions
  • MODERATE: Balanced between usability and accuracy
  • STRICT: Optimized for maximum detection accuracy

All custom configurations must meet or exceed the minimum requirements defined by the RELAXED preset.

Camera Kit Quality Configuration supports both skincare and hdskincare.


Preset Behavior

PresetDescription
RELAXEDLess strict validation for smoother user experience
MODERATEBalanced validation for most use cases
STRICTTight validation for high accuracy scenarios

When using qualityOverrides, you may specify only the parameters you want to change. Unspecified parameters fall back to the active preset defaults.


Configuration Object

{
  "face_ratio_lower_threshold": 0.55,
  "face_ratio_upper_threshold": 1,
  "face_left_boundary_lower_threshold": 0,
  "face_left_boundary_upper_threshold": 1,
  "face_right_boundary_lower_threshold": 0,
  "face_right_boundary_upper_threshold": 1,
  "face_top_boundary_lower_threshold": 0,
  "face_top_boundary_upper_threshold": 1,
  "face_bottom_boundary_lower_threshold": 0,
  "face_bottom_boundary_upper_threshold": 1,
  "pitch_lower_threshold": -20,
  "pitch_upper_threshold": 10,
  "yaw_lower_threshold": -15,
  "yaw_upper_threshold": 15,
  "roll_lower_threshold": -15,
  "roll_upper_threshold": 15,
  "lighting_lower_threshold": 0.55,
  "lighting_upper_threshold": 0.8,
  "lighting_uneven_threshold": 0.2
}

Parameters

Face Ratio Control

Controls the acceptable proportion of the detected face.

  • Measurement basis:
    • Landscape mode: vertical ratio
    • Portrait mode: horizontal ratio
ParameterDescriptionAllowed RangePreset Defaults
face_ratio_lower_thresholdMinimum face ratio0.55 to 1.0STRICT 0.75, MODERATE 0.65, RELAXED 0.55
face_ratio_upper_thresholdMaximum face ratio1.01.0 (all presets)

Face Boundary Control

Defines how close the face can be to the frame edges.

ParameterDescriptionAllowed RangeDefault
face_left_boundary_lower_thresholdLeft boundary minimum0.0 to 1.00.0
face_left_boundary_upper_thresholdLeft boundary maximum0.0 to 1.01.0
face_right_boundary_lower_thresholdRight boundary minimum0.0 to 1.00.0
face_right_boundary_upper_thresholdRight boundary maximum0.0 to 1.01.0
face_top_boundary_lower_thresholdTop boundary minimum0.0 to 1.00.0
face_top_boundary_upper_thresholdTop boundary maximum0.0 to 1.01.0
face_bottom_boundary_lower_thresholdBottom boundary minimum0.0 to 1.00.0
face_bottom_boundary_upper_thresholdBottom boundary maximum0.0 to 1.01.0

Head Pose Angle Control

Controls allowable head orientation.

ParameterDescriptionAllowed RangePreset Defaults
pitch_lower_thresholdMinimum pitch angle-20 to 10STRICT -10, MODERATE -15, RELAXED -20
pitch_upper_thresholdMaximum pitch angle-20 to 10STRICT 0, MODERATE 5, RELAXED 10
yaw_lower_thresholdMinimum yaw angle-15 to 15STRICT -5, MODERATE -10, RELAXED -15
yaw_upper_thresholdMaximum yaw angle-15 to 15STRICT 5, MODERATE 10, RELAXED 15
roll_lower_thresholdMinimum roll angle-15 to 15STRICT -5, MODERATE -10, RELAXED -15
roll_upper_thresholdMaximum roll angle-15 to 15STRICT 5, MODERATE 10, RELAXED 15

Lighting Control

Defines acceptable lighting quality and uniformity.

ParameterDescriptionAllowed RangePreset Defaults
lighting_lower_thresholdMinimum lighting level0.55 to 1.0STRICT 0.8, MODERATE 0.7, RELAXED 0.55
lighting_upper_thresholdMaximum lighting level0.8 to 1.0STRICT 0.9, MODERATE 0.85, RELAXED 0.8
lighting_uneven_thresholdMaximum luma difference between eyes0.0 to 0.2STRICT 0.1, MODERATE 0.15, RELAXED 0.2

Validation Rules

  • Custom values must not be less restrictive than RELAXED preset values.
  • Only specified fields in qualityOverrides are applied.
  • All unspecified parameters default to the selected preset.

Detection Modes

Configure the faceDetectionMode in YMK.init() to suit your specific use case.

ModeDescription
makeupStandard camera mode for virtual cosmetic try-on.
skincareStandard skin analysis mode, close-up face capture. Support AI Skin Analysis and AI Skin Simulation.
hdskincareHigh-definition capture for AI skin analysis using webcams with a minimum resolution of 2560 pixels on the longer side, subject to device support.
shadefinderSkin Tone Analysis front-face capture.
facereshapeAI Face Reshape capture and AI Face Lift.
hairlengthFull hair-length capture (from a distance).
hairfrizziness3-phase capture: front, right-turn, left-turn.
hairtypeSame 3-phase multi-angle capture flow.
hairdensityA 45‑degree downward head‑angle photograph.
ringHand capture for ring virtual try‑on.
wristWrist capture for watch or bracelet virtual try‑on.
necklaceSelfie capture for necklace try-on.
earringSelfie capture for earring virtual try-on.
teethwhitenFront‑facing selfie that detects whether teeth are visible; photo taken only when detected.
nailHand capture for nails virtual try‑on.
comprehensivePhoto to be used simultaneously for AI Makeup, AI Skin Analysis, and AI Facial Attributes & Ratio Analysis.

Events Reference

Lifecycle & Status Events

EventDescription
openedModule opened.
loadingLoading progress (0–100).
loadedCamera stream loaded onto canvas.
closedModule closed.
faceDetectionStartedUser enters the detection UI.

Camera Events

EventDescription
cameraOpenedWebcam opened successfully.
cameraClosedWebcam closed.
cameraFailedPermission denied or no webcam found. Error codes include "error_resolution_unsupported", "error_permission_denied", "error_access_failed".
unsupportedResolutionFired when the device resolution does not meet the minimum requirements for the selected mode.

Detection Events

faceQualityChanged

Fires continuously during detection as quality metrics update.

Example Payload:

{
  "hasFace": true,
  "position": "good",
  "frontal": "good",
  "lighting": "ok"
}

Field Definitions:

  • hasFace: (boolean) Whether a face is detected.
  • position: (string) Face distance/size quality ("good", "notgood", "toosmall", "outofboundary").
  • frontal: (string) Whether user is facing forward ("good", "notgood").
  • lighting: (string) Lighting strength ("good", "ok", "notgood").

faceDetectionCaptured

Fired after all required face quality validation checks have passed and the Camera Kit has successfully completed the capture workflow. Depending on the mode, this may contain one or multiple images.

Example Payload:

{
  "mode": "makeup",
  "images": [
    {
      "phase": 0,
      "image": "data:image/jpeg;base64,...",
      "width": 500,
      "height": 500
    }
  ]
}

Image Object Fields:

  • phase: (integer) Zero-based index representing the capture step.
  • image: (string | Blob) The captured image data.
  • width: (integer) Pixel width of the captured image.
  • height: (integer) Pixel height of the captured image.

Configuration Notes

Quality Requirements

To ensure successful capture:

  1. Distance: Ensure correct face distance (not too zoomed in/out).
  2. Angle: Ensure frontal face angle.
  3. Lighting: Provide sufficient lighting (avoid shadows or dark environments).

Multi-Phase Capture

Modes like hairtype or hairfrizziness require multiple steps:

  1. Front face
  2. Turn right
  3. Turn left

Ensure your event handling logic accounts for multiple images in the faceDetectionCaptured result array.

Advanced Configuration

  • Flip Button: Use hideFlipCameraButton: true to enforce a specific camera orientation if your UX requires it.
  • Capture Delay: Adjust countingDuration (default 800) to give users more time to review the capture before auto-submission occurs.
const minQuality = {
  hasFace: true,
  area: "good",
  frontal: "good",
  lighting: "ok"
};
Languages
Servers
https://yce-api-01.makeupar.com