Sign Up

Log In

Animetrics Face Recognition

FREEMIUM
By animetrics
Updated 19 hours ago
Media
8/10
Popularity Score
3365ms
Latency
99%
Success Rate

Animetrics Face Recognition API Documentation

The Animetrics Face Recognition API can be used to find human faces, detect feature points, correct for off angle photographs, and ultimately perform facial recognition. Information on facial features, including ears, nose, eyebrows, lips, chin are returned as coordinates on the image. The Animetrics Face Recognition API will also detect and return the gender and orientation, or "pose" of faces along 3 axes.

A special capability called "SetPose" is also available which allows the face to be re-rendered at a desired pose that is different than the captured pose. I.e. as if the photo was taken with respect to any desired angle relative to the camera. This is typically used when the facial photo is captured off angle and a zero-corrected fully frontal image (0 degrees pitch, yaw, and roll) is required.

Detected facial features may be corrected or modified to improve the final results of subsequent steps. For example, an eye in the picture may be hidden or obscured; requesting just eye feature points, manually correcting their locations, and feeding this data into a more detailed request will help improve the accuracy of additional feature point and pose detection.

View API Details

Supercharge your App

Discover and connect to thousands of APIs in the world's largest API Hub
POSTDetect Features
GETAdd To Gallery
POSTDetect
GETList Galleries
GETEnroll
GETRecognize
GETRemove From Gallery
GETView Gallery
GETVerify
GETView Subject
GETDelete Face
GETAssign Face to Subject
GETUsage
POST/v2/detect
GET/v2/add_to_gallery
GET/v2/assign_face_to_subject
GET/v2/delete_face
POST/v2/detect_features
GET/v2/enroll
GET/v2/list_galleries
GET/v2/recognize
GET/v2/remove_from_gallery
GET/v2/view_gallery
GET/v2/view_subject
GET/v2/usage
POSTDetect Features

Finds either eye information, full feature information, or full features + "Setpose" for one face in a picture. Face bounding box or eye center coordinates must be supplied, and may be taken from the output of basic Detect. "Setpose" is a returned image which contains a frontal view of a face which has been zero-corrected for pitch, yaw, and roll (like a mug shot). Intended for more detailed detection than basic Detect. Since this function takes the face bounding box or eye coordinates, corrections may be made on the values output from Detect. The image_id returned by this function is a reference to a temporarily cached image that can be passed back to other Detect Features calls, or Enroll or Find calls. Setpose images are returned as URLs which are made private through obfuscation. Setpose image urls expire after 20 minutes. All binary images supplied to this function are stored for later use by Enroll and Find operations. Images are deleted after 5 hours.

Authorization:

description

FreemiumThis API has a free, limited plan and paid plans. You can subscribe directly to it from Rakuten RapidAPI.
Sign up to test this endpoint
Log in
Header Parameters
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
api_keyQUERY
REQUIREDPlease visit http://api.animetrics.com to sign up for an API key.
Optional Parameters
leftEyeCenterXNUMBER
OPTIONAL(required if face coordinates/dimensions omitted) X-Coordinate for the left eye center. May be modified from basic Detect output.
heightNUMBER
OPTIONALHeight of face. May be modified from basic Detect output.
rightEyeCenterYNUMBER
OPTIONAL(required if face coordinates/dimensions omitted) Y-Coordinate for the right eye center. May be modified from basic Detect output.
rightEyeCenterXNUMBER
OPTIONAL(required if face coordinates/dimensions omitted) X-Coordinate for the right eye center. May be modified from basic Detect output.
topLeftXNUMBER
OPTIONALX-Coordinate for top left corner of face. May be modified from basic Detect output.
topLeftYNUMBER
OPTIONALY-Coordinate for top left corner of face. May be modified from basic Detect output.
widthNUMBER
OPTIONALWidth of face. May be modified from basic Detect output.
leftEyeCenterYNUMBER
OPTIONAL(required if face coordinates/dimensions omitted) Y-Coordinate for the left eye center. May be modified from basic Detect output.
image_idSTRING
OPTIONAL(optional, required if url and image omitted) an image ID that was returned from a basic detect operation
urlSTRING
OPTIONALimage url containing possible face or faces for detection
selectorSTRING
OPTIONALreturn information on one face + eyes in the image ("EYES" - default), full features ("FULL") for one face, or full features + set pose ("SETPOSE")
imageBINARY
OPTIONAL(optional, required if url and image_id omitted) jpg or png multipart image stream containing one face of this person
Request Snippet
unirest.post("https://animetrics.p.rapidapi.com/detect_features")
.header("X-RapidAPI-Key", "undefined")
.field("leftEyeCenterX", undefined)
.field("height", undefined)
.field("rightEyeCenterY", undefined)
.field("rightEyeCenterX", undefined)
.field("topLeftX", undefined)
.field("topLeftY", undefined)
.field("width", undefined)
.field("leftEyeCenterY", undefined)
.field("image_id", "undefined")
.field("url", "undefined")
.field("selector", "undefined")
.attach("image", fs.createReadStream("undefined"))
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response

loading...

Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://animetrics.p.rapidapi.com/detect_features")
.header("X-RapidAPI-Key", "undefined")
.field("leftEyeCenterX", undefined)
.field("height", undefined)
.field("rightEyeCenterY", undefined)
.field("rightEyeCenterX", undefined)
.field("topLeftX", undefined)
.field("topLeftY", undefined)
.field("width", undefined)
.field("leftEyeCenterY", undefined)
.field("image_id", "undefined")
.field("url", "undefined")
.field("selector", "undefined")
.attach("image", fs.createReadStream("undefined"))
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication

Sign up for free

to test this endpoint

Join the world’s largest API marketplace with over half a million developers and thousands of APIs.
DiscoverAPIs
Testfrom the browser
Connectusing code snippets
Managefrom one dashboard