POWERING HUMAN ANALYTICS THROUGH DEEP LEARNING.





Upload an Image and get results

getTags

This method allows user to uploads an image(base64) and get the requested tags information

/getTags

Permission: admin  

https://api.btbp.org/deeptag/AppService.svc/getTags

Parameter

Field Type IsRequred Description
APIKey String YES

API KEY

UserId String NO

We recommend you to use this and send a unique ID(such as emailID or randomID or any other info) for each user. This helps to track past results

Latitude String NO

current location latitude

Longitude String NO

current location longitude

Tags String[] YES

Tags list should be an array

Available tags:

ImageBytes String[] YES

base64 string subdivided into Array

Success 200

Field Type Description
Message String

overall status message

ImageId String

Encrypted Image ID for future usage

TimeStamp String

Time stamp of the response

Tags Object[]

List of tags (Array of Objects).

  TagName String

Name of the tag.

  TagImage String

Base64 string of the tag image (Available only if the feature has result image).

  Status bool

Status of the tag

  Message string

Internal tag status message

  TagValues Object[]

List of tagValues (Array of Objects).

    Value String

Tags value

    ValueName String

Name of the value, if applicable. Else, NA is returned.

    Units String

Units of the value, if applicable. Else, NA is returned.

    Confidence String

Confidence level in percentage, if applicable. Else, NA is returned.

Error 401

Field Description
Error

Authentication failed, Invalid API Key

Error 400

Field Description
Error

Bad Request, apiKey/input image/features missing

Error 500

Field Description
Error

Internal server error

Error 504

Field Description
Error

Gateway Timeout

    HTTP: 401 Not Authenticated
    {
      "Error": "Authentication failed, Invalid API Key"
    }
	
    HTTP: 200 Success
    {
      "Message":"Analysed successfully",
      "ImageId":"xyzxyzxyzyxz",
      "TimeStamp":"2017-05-01 13:13:31",
      "Tags":[{
                "TagName":"AGE_GROUP",
                "Status":true,
                "Message":"Tag data is available",
                "TagValues":[{
                     "ValueName":"",
                     "Value":"0-12",
                     "Units":"Range(Years)"
                     "Confidence":""
                }]
      }]
    }
	

updateTags

This method allows user to update actual tags

/updateTags

Permission: admin  

https://api.btbp.org/deeptag/AppService.svc/updateTags

Parameter

Field Type IsRequred Description
ImageId String YES

imageID which was returned in the getTags response

Tags Object[] YES

List of tagValues (Array of Objects).

  TagName string YES

Name of the Tag

  TagValue string YES

Value of the Tag

Success 200

Field Type Description
Message String

Status message

Error 401

Field Description
Error

Invalid Image ID

Error 400

Field Description
Error

Bad Request, Invalid object/value missing

Error 500

Field Description
Error

Internal server error

Error 504

Field Description
Error

Gateway Timeout

    HTTP: 400 Bad Request
    {
      "Error": "Invalid Image ID"
    }
	
    HTTP: 200 Success
    {
      "Message": "Updated successfully"
    }
	

Rejection Codes

Code ReasonForRejection CorrectiveAction
415 We could not detect your face. Use the camera guidelines to position your chin and forehead so both are visible in the photo.
417 We could not detect your eyes. Be sure to open your eyes, or remove glasses and ensure that your face is well lit.
419 Please keep a neutral expression. For best results avoid smiling and have a relaxed, neutral expression in your photo.
109 Your photo resolution is too low For best results take a photo that is 0.3 megapixels or higher in resolution.
209 Your photo is too dark Check the lighting before you take a photo, lots of even lighting works best.
309 Your photo is too dark Check the lighting before you take a photo, lots of even lighting works best.
409 Adjust the position of your face in the photo. For best results make sure your face is centrally aligned in the photo.
509 Face is too far away. For best results make sure your chin, forehead, and sides of the face are aligned with the guidelines.
609 Face is too far away. Hold the camera closer to your face and use the guide lines as a reference for positioning.
709 Uneven lightining Make sure there is even lighting across your forehead.
809 Uneven lightining. Make sure there is even lighting across your cheeks.
909 Uneven lightining. Make sure there is even lighting across your face.
1009 Photo is too shiny. Shiny skin areas can interfere with analysis. Re-take your photo with even lighting across your face.
1001 Uneven focus Make sure your entire face is in focus, not just the forehead.
416 Too many faces detected For best results we need you alone in the photo.
111 Poor lightining For best results make sure your photo is well lit.
1209 Too much Tilt In Face Please face the camera straight on when capturing a photo.

Tags Information

FACE AI

Available tags:

AGE_GROUP / AGEGROUP :
Returns the age group of the person in the input image
Available Age groups:0-12 , 13-18 , 19-25 , 26-32 , 33-40 , 41-50 , 51-60 , 61-70 , 71+
Output Ex: 0-12
Units: Range(Years)
GENDER :
Returns the gender of the person in the input image
Output Ex: Male
DISCRETE_AGE / DiscreteAge :
Returns the approximate age of the person in the input image
Output Ex: 56
Units: Years
LIPBOUNDARY :
Image of the person with lip outline highlighted
Output Ex: Base64 image
SKINTYPE :
Returns Skintype of the person in the input image
Available Skintypes are 1,2,3,4,5,6
Output: Ex: 2

Lifestyle AI

Available tags:

GEOLOCATION_COUNTRY :
Returns the country where the image has been uploaded
Output Ex: India

GEOLOCATION_CITY :
Returns the city where the image has been uploaded
Output Ex: Hyderabad

POLLUTION_AQI :
Returns the AQI index value of the location where the image has been uploaded
Output Ex: 50

UV INDEX :
Returns the UV index value of the location where the image has been uploaded
Output Ex: 13

Skin AI


Wrinkles

Available tags:

WRINKLES_IMAGE :
Image of the person with wrinkles highlighted
Output Ex: Base64 image
WRINKLES_SEVERITY_SCORE :
Returns wrinkles Score(1-5) of the person in the input image
Output Ex: 2
WRINKLES_SURFACE_AREA :
Returns wrinkles Area affected of the person in the input image
Output Ex: 3.4568

Acne

Available tags:

ACNE_IMAGE :
Image of the person with acne highlighted
Output Ex: Base64 image
ACNE_SEVERITY_SCORE :
Returns acne Score(1-5) of the person in the input image
Output Ex: 2

Spots

Available tags:

SPOTS_IMAGE :
Image of the person with pigmentation highlighted
Output Ex: Base64 image

SPOTS_SEVERITY_SCORE :
Returns pigmentation Score(1-5) of the person in the input image
Output Ex: 2

Pores

Available tags:

PORES_IMAGE :
Image of the person with pores highlighted
Output Ex: Base64 image
PORES_SEVERITY_SCORE :
Returns pores Score(1-5) of the person in the input image
Output Ex: 2

Redness

Available tags:

REDNESS_IMAGE :
Image of the person with redness highlighted
Output Ex: Base64 image
REDNESS_SEVERITY_SCORE :
Returns redness Score(1-5) of the person in the input image
Output Ex: 2

Uneven skin tone

Available tags:

UNEVEN_SKINTONE_IMAGE :
Image of the person with skin tone unevenness highlighted
Output Ex: Base64 image
UNEVEN_SKINTONE_SEVERITY_SCORE :
Returns skin tone uneven Score(1-5) of the person in the input image
Output Ex: 2

Dark circles

Available tags:

DARK_CIRCLES_IMAGE :
Image of the person with dark circles highlighted
Output Ex: Base64 image
DARK_CIRCLES_SEVERITY_SCORE :
Returns dark circles Score(1-5) of the person in the input image
Output Ex: 2
DARK_CIRCLES_DARKNESS :
Returns the contrast score ( 0-100) of under eye with respect to cheek
Output Ex: 5

Oiliness

Available tags:
OILINESS_IMAGE :
Image of the person with oiliness area highlighted
Output Ex: Base64 image
OILINESS_SEVERITY_SCORE :
Returns oiliness score(1-5) of the person in the input image
Output Ex: 2

Lips

Available tags:
LIP_ROUGHNESS_SEVERITY_SCORE :
Returns roughness/uneveness score (1-5) of the lip in the input image.
Output Ex: 2

Dehydration

Available tags:
DEHYDRATION_SEVERITY_SCORE :
Returns dehydration severity score (1-5) of the person in the input image.
Output Ex: 2