Skip to main content

Endpoint

POST /v3/universal-ai (sync) Model string pattern: image/face_detection/{provider}[/{model}]

Input

FieldTypeRequiredDescription
filefile_inputYesImage file ID from /v3/upload or direct file URL

Output

FieldTypeRequiredDescription
itemsarray[object]No
    confidencefloatYes
    landmarksobjectYes
        left_eyearray[float]No
        left_eye_toparray[float]No
        left_eye_rightarray[float]No
        left_eye_bottomarray[float]No
        left_eye_leftarray[float]No
        right_eyearray[float]No
        right_eye_toparray[float]No
        right_eye_rightarray[float]No
        right_eye_bottomarray[float]No
        right_eye_leftarray[float]No
        left_eyebrow_leftarray[float]No
        left_eyebrow_rightarray[float]No
        left_eyebrow_toparray[float]No
        right_eyebrow_leftarray[float]No
        right_eyebrow_rightarray[float]No
        left_pupilarray[float]No
        right_pupilarray[float]No
        nose_tiparray[float]No
        nose_bottom_rightarray[float]No
        nose_bottom_leftarray[float]No
        mouth_leftarray[float]No
        mouth_rightarray[float]No
        right_eyebrow_toparray[float]No
        midpoint_between_eyesarray[float]No
        nose_bottom_centerarray[float]No
        nose_left_alar_out_tiparray[float]No
        nose_left_alar_toparray[float]No
        nose_right_alar_out_tiparray[float]No
        nose_right_alar_toparray[float]No
        nose_root_leftarray[float]No
        nose_root_rightarray[float]No
        upper_liparray[float]No
        under_liparray[float]No
        under_lip_bottomarray[float]No
        under_lip_toparray[float]No
        upper_lip_bottomarray[float]No
        upper_lip_toparray[float]No
        mouth_centerarray[float]No
        mouth_toparray[float]No
        mouth_bottomarray[float]No
        left_ear_tragionarray[float]No
        right_ear_tragionarray[float]No
        forehead_glabellaarray[float]No
        chin_gnathionarray[float]No
        chin_left_gonionarray[float]No
        chin_right_gonionarray[float]No
        upper_jawline_leftarray[float]No
        mid_jawline_leftarray[float]No
        mid_jawline_rightarray[float]No
        upper_jawline_rightarray[float]No
        left_cheek_centerarray[float]No
        right_cheek_centerarray[float]No
    emotionsobjectYes
        joyintYes
        sorrowintYes
        angerintYes
        surpriseintYes
        disgustintYes
        fearintYes
        confusionintYes
        calmintYes
        unknownintYes
        neutralintYes
        contemptintYes
    posesobjectYes
        pitchfloatYes
        rollfloatYes
        yawfloatYes
    agefloatYes
    genderstringYes
    bounding_boxobjectYes
        x_minfloatYes
        x_maxfloatYes
        y_minfloatYes
        y_maxfloatYes
    hairobjectYes
        hair_colorarray[object]No
            colorstringYes
            confidencefloatYes
        baldfloatYes
        invisibleboolYes
    facial_hairobjectYes
        moustachefloatYes
        beardfloatYes
        sideburnsfloatYes
    qualityobjectYes
        noisefloatYes
        exposurefloatYes
        blurfloatYes
        brightnessfloatYes
        sharpnessfloatYes
    makeupobjectYes
        eye_makeboolYes
        lip_makeboolYes
    accessoriesobjectYes
        sunglassesfloatYes
        reading_glassesfloatYes
        swimming_gogglesfloatYes
        face_maskfloatYes
        eyeglassesfloatYes
        headwearfloatYes
    occlusionsobjectYes
        eye_occludedboolYes
        forehead_occludedboolYes
        mouth_occludedboolYes
    featuresobjectYes
        eyes_openfloatYes
        smilefloatYes
        mouth_openfloatYes

Available Providers

ProviderModel StringPrice
amazonimage/face_detection/amazon$1 per 1,000 files
api4aiimage/face_detection/api4ai$0.75 per 1,000 files
clarifaiimage/face_detection/clarifai$2 per 1,000 files
googleimage/face_detection/google$1.5 per 1,000 files

Quick Start

import requests

url = "https://api.edenai.run/v3/universal-ai"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

payload = {
    "model": "image/face_detection/amazon",
    "input": {
        "file": "YOUR_FILE_UUID_OR_URL"
    }
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())