Face Recognition

By betaface
Updated 6 months ago
Visual Recognition
Popularity Score
Success Rate

Face Recognition API Documentation

Detect, analyze and recognize faces

View API Details
POSTupload media
POSTupload media file
GETget media info
GETget media info by hash
POSTrecognize faces
GETrecognize result
POSTset person
POSTtransform faces
GETtransform result
GETface info
GETface info (cropped)
POSTupload media

upload and optionally directly process media file using file uri or file content as base64 encoded string

Header Parameters
Required Parameters
upload mediaJSON_STRING
REQUIREDParameters: file_uri - string publicly accessible media file uri. file_base64 - string base64 encoded media file content. file_uri parameter will be ignored if file_base64 parameter is specified and not empty. detection_flags - string (optional) comma separated list of detection flags: bestface - return only face with highest detection score, propoints - 101 pro points detection, classifiers - face classification and attributes, extended - extended color and geometric measurements, content - image content detection. detection_min_score - number($double) (optional) filter faces with detection score lower than min_score. detection_new_faces - array[] (optional) override automatic faces detection and manually specify faces locations, face points and person ids to assign. provide a list of new faces as an array of entries with following template: { "x": 0, "y": 0, "width": 0, "height": 0, "angle": 0, "points": [ { "x": 0, "y": 0, "type": 0 }, { "x": 0, "y": 0, "type": 0 }], "tags": [ { "name": "", "value": "", "confidence": 1.0 }, {"name": "", "value": "", "confidence": 1.0 } ], "set_person_id": ""} set_person_id - string (optional) set person id in format [email protected] to each detected face. recommended to use with detection_flags bestface and/or min_score minimum detection score parameter. recognize_targets - array[string] (optional) for each detected face run recognize against specified targets (face ids, person ids or namespaces). recognize_parameters - string (optional) comma separated list of recognition parameters, currently supported min_match_score (minimum recognition score), min_score (minimum detection score), gender and race filter. for example: “min_match_score:0.4,min_score:0.2,gender:male,race:white” original_filename - string (optional) original media filename, path, uri or your application specific id that you want to be stored in media metadata for reference.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication