Human Detection API Guide

Human Detection

Overview

Detect and find total count of people within an image, and returns with high accuracy people scores and total people count.

Details

Request URL:- https://faceapi.mxface.ai/api/v3/face/PeopleDetection

Method Type:-POST

Headers:-

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxxx

Request Body

{
  "encoded_image": "/9j/4AAQSkZJRgABAQAAAQA……"
}

Request Parameters

Param Required Type Description
encoded_image Yes String base64 encoded string
returnImage Optional bool If true, then api will return bounding box people in image. If false, then score and count will return

Response Body

{
  "peopleCount": 1,
  "score": [
    0.9452115297317505
  ]
}

Response Parameters

Param Type Description
peopleCount int Total number of people detected in image.
score float Each detected people quality scores in array

Errors

Error Code Message
200 Success
401 Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription.
400 Invalid request. Please pass valid json with all required parameters.
Not valid biometric data or invalid format.
The input is not a valid Base-64 string.
500 Something went wrong, please try again later.