Last 7 days, UTC

Average Latency
59ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time

Simple & Straightforward Pricing

Pay as you go. No long-term contracts.

Freemium

$0

additional fees may apply

Detect Enroll Recognize

1,000 / mo.

$0.0500 per extra

Detect Face detection (face, eyes, full features)

Setpose Create a frontal facing image from an off angle face

Recognize Search recognition database for a facial match

Enroll Enroll faces into recognition database

Unlimited Gallery Size No limit on number of galleries nor number of faces in gallery

Subscribe

premium

$299.00

per month

Detect Enroll Recognize

50,000 / mo.

$0.0100 per extra

Detect Face detection (face, eyes, full features)

Setpose Create a frontal facing image from an off angle face

Recognize Search recognition database for a facial match

Enroll Enroll faces into recognition database

Unlimited Gallery Size No limit on number of galleries nor number of faces in gallery

Subscribe

ultra

$999.00

per month

Detect Enroll Recognize

500,000 / mo.

$0.0050 per extra

Detect Face detection (face, eyes, full features)

Setpose Create a frontal facing image from an off angle face

Recognize Search recognition database for a facial match

Enroll Enroll faces into recognition database

Unlimited Gallery Size No limit on number of galleries nor number of faces in gallery

Subscribe
Query Authentication

Authentication
Description
Parameter
String

Please visit http://api.animetrics.com to sign up for an API key.

api_key

Required

Endpoints

HTTP 200 : Image POST/detect
Represents an image supplied to the api that has been processed. May contain zero or more faces.
						[{
    "images": [
        {
            "time": 2.98294,
            "status": "Complete",
            "url": "http://24.103.204.172/img/test/mk.jpg",
            "width": 600,
            "height": 582,
            "faces": [
                {
                    "topLeftX": 189,
                    "topLeftY": 149,
                    "width": 175,
                    "height": 175,
                    "leftEyeCenterX": 229.104,
                    "leftEyeCenterY": 186.917,
                    "rightEyeCenterX": 323.896,
                    "rightEyeCenterY": 192.021,
                    "noseTipX": 265.989,
                    "noseTipY": 246.91,
                    "noseBtwEyesX": 274.313,
                    "noseBtwEyesY": 190.021,
                    "chinTipX": 270.081,
                    "chinTipY": 312.169,
                    "leftEyeCornerLeftX": 212.891,
                    "leftEyeCornerLeftY": 184.559,
                    "leftEyeCornerRightX": 251.161,
                    "leftEyeCornerRightY": 191.076,
                    "rightEyeCornerLeftX": 306.043,
                    "rightEyeCornerLeftY": 192.545,
                    "rightEyeCornerRightX": 349.155,
                    "rightEyeCornerRightY": 191.896,
                    "rightEarTragusX": -1,
                    "rightEarTragusY": -1,
                    "leftEarTragusX": -1,
                    "leftEarTragusY": -1,
                    "leftEyeBrowLeftX": 192.648,
                    "leftEyeBrowLeftY": 163.369,
                    "leftEyeBrowMiddleX": 219.835,
                    "leftEyeBrowMiddleY": 157.958,
                    "leftEyeBrowRightX": 249.481,
                    "leftEyeBrowRightY": 173.279,
                    "rightEyeBrowLeftX": 300.299,
                    "rightEyeBrowLeftY": 173.451,
                    "rightEyeBrowMiddleX": 341.983,
                    "rightEyeBrowMiddleY": 162.189,
                    "rightEyeBrowRightX": 371.793,
                    "rightEyeBrowRightY": 172.751,
                    "nostrilLeftHoleBottomX": 252.914,
                    "nostrilLeftHoleBottomY": 257.574,
                    "nostrilRightHoleBottomX": 282.944,
                    "nostrilRightHoleBottomY": 261.791,
                    "nostrilLeftSideX": 240.333,
                    "nostrilLeftSideY": 253.962,
                    "nostrilRightSideX": 300.614,
                    "nostrilRightSideY": 256.05,
                    "lipCornerLeftX": 229.551,
                    "lipCornerLeftY": 290.118,
                    "lipLineMiddleX": 266.147,
                    "lipLineMiddleY": 288.209,
                    "lipCornerRightX": 311.985,
                    "lipCornerRightY": 294.562,
                    "pitch": 5.4466,
                    "yaw": 3.33709,
                    "roll": 4.90042
                }
            ]
        }
    ]
}]						
Detect

Finds either face information (a bounding box around faces), face + eye information including eye centers and possibly eye corners (eye corners should not be relied on to be present in every response), or full feature information including eyebrows, eye corners, nose, chin, lips, and ears for each face. Intended for faster detection and pre-processing of images. The output face or eye coordinates of this function may be modified and sent to Detect Features. Coordinates all begin at the top left of the image. The image_id returned by this function is a reference to a temporarily cached image that can be passed to Detect Features, Enroll, or Find operations. All binary images supplied to this function are stored for later use by Enroll and Find operations. Images are deleted after 5 hours.


Test console
Description
Parameter
string

return information on all faces in the image ("FACE" - default), all faces + eyes ("EYES"), or full features ("FULL") for all faces (see sample response for features)
Example: FACE, EYES, FULL

selector

Optional

string

image url containing possible face or faces for detection
Example: http://example.com/some_image.jpg

url

Optional

binary

(optional, required if url omitted) jpg or png multipart image stream containing one face of this person

image

Optional

HTTP 200 : Image POST/detect_features
Represents an image supplied to the api that has been processed. May contain zero or more faces.
						[{
    "images": [
        {
            "time": 2.98294,
            "status": "Complete",
            "url": "http://24.103.204.172/img/test/mk.jpg",
            "width": 600,
            "height": 582,
            "faces": [
                {
                    "topLeftX": 189,
                    "topLeftY": 149,
                    "width": 175,
                    "height": 175,
                    "leftEyeCenterX": 229.104,
                    "leftEyeCenterY": 186.917,
                    "rightEyeCenterX": 323.896,
                    "rightEyeCenterY": 192.021,
                    "noseTipX": 265.989,
                    "noseTipY": 246.91,
                    "noseBtwEyesX": 274.313,
                    "noseBtwEyesY": 190.021,
                    "chinTipX": 270.081,
                    "chinTipY": 312.169,
                    "leftEyeCornerLeftX": 212.891,
                    "leftEyeCornerLeftY": 184.559,
                    "leftEyeCornerRightX": 251.161,
                    "leftEyeCornerRightY": 191.076,
                    "rightEyeCornerLeftX": 306.043,
                    "rightEyeCornerLeftY": 192.545,
                    "rightEyeCornerRightX": 349.155,
                    "rightEyeCornerRightY": 191.896,
                    "rightEarTragusX": -1,
                    "rightEarTragusY": -1,
                    "leftEarTragusX": -1,
                    "leftEarTragusY": -1,
                    "leftEyeBrowLeftX": 192.648,
                    "leftEyeBrowLeftY": 163.369,
                    "leftEyeBrowMiddleX": 219.835,
                    "leftEyeBrowMiddleY": 157.958,
                    "leftEyeBrowRightX": 249.481,
                    "leftEyeBrowRightY": 173.279,
                    "rightEyeBrowLeftX": 300.299,
                    "rightEyeBrowLeftY": 173.451,
                    "rightEyeBrowMiddleX": 341.983,
                    "rightEyeBrowMiddleY": 162.189,
                    "rightEyeBrowRightX": 371.793,
                    "rightEyeBrowRightY": 172.751,
                    "nostrilLeftHoleBottomX": 252.914,
                    "nostrilLeftHoleBottomY": 257.574,
                    "nostrilRightHoleBottomX": 282.944,
                    "nostrilRightHoleBottomY": 261.791,
                    "nostrilLeftSideX": 240.333,
                    "nostrilLeftSideY": 253.962,
                    "nostrilRightSideX": 300.614,
                    "nostrilRightSideY": 256.05,
                    "lipCornerLeftX": 229.551,
                    "lipCornerLeftY": 290.118,
                    "lipLineMiddleX": 266.147,
                    "lipLineMiddleY": 288.209,
                    "lipCornerRightX": 311.985,
                    "lipCornerRightY": 294.562,
                    "pitch": 5.4466,
                    "yaw": 3.33709,
                    "roll": 4.90042
                }
            ]
        }
    ]
}]						
Detect 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.


Test console
Description
Parameter
number

X-Coordinate for top left corner of face. May be modified from basic Detect output.
Example: 105

topLeftX

Optional

number

Y-Coordinate for top left corner of face. May be modified from basic Detect output.
Example: 188

topLeftY

Optional

number

Width of face. May be modified from basic Detect output.
Example: 123

width

Optional

number

Height of face. May be modified from basic Detect output.
Example: 123

height

Optional

number

(required if face coordinates/dimensions omitted) X-Coordinate for the left eye center. May be modified from basic Detect output.
Example: 139.817

leftEyeCenterX

Optional

number

(required if face coordinates/dimensions omitted) Y-Coordinate for the left eye center. May be modified from basic Detect output.
Example: 160.727

leftEyeCenterY

Optional

number

(required if face coordinates/dimensions omitted) X-Coordinate for the right eye center. May be modified from basic Detect output.
Example: 198.365

rightEyeCenterX

Optional

number

(required if face coordinates/dimensions omitted) Y-Coordinate for the right eye center. May be modified from basic Detect output.
Example: 164.909

rightEyeCenterY

Optional

string

return information on one face + eyes in the image ("EYES" - default), full features ("FULL") for one face, or full features + set pose ("SETPOSE")
Example: EYES, FULL, SETPOSE

selector

Optional

string

image url containing possible face or faces for detection
Example: http://example.com/some_image.jpg

url

Optional

binary

(optional, required if url and image_id omitted) jpg or png multipart image stream containing one face of this person

image

Optional

string

(optional, required if url and image omitted) an image ID that was returned from a basic detect operation

image_id

Optional

HTTP 200 : Image GET/enroll
Represents an image supplied to the api that has been processed. May contain zero or more faces.
						[{
    "images": [
        {
            "time": 2.98294,
            "status": "Complete",
            "url": "http://24.103.204.172/img/test/mk.jpg",
            "width": 600,
            "height": 582,
            "faces": [
                {
                    "topLeftX": 189,
                    "topLeftY": 149,
                    "width": 175,
                    "height": 175,
                    "leftEyeCenterX": 229.104,
                    "leftEyeCenterY": 186.917,
                    "rightEyeCenterX": 323.896,
                    "rightEyeCenterY": 192.021,
                    "noseTipX": 265.989,
                    "noseTipY": 246.91,
                    "noseBtwEyesX": 274.313,
                    "noseBtwEyesY": 190.021,
                    "chinTipX": 270.081,
                    "chinTipY": 312.169,
                    "leftEyeCornerLeftX": 212.891,
                    "leftEyeCornerLeftY": 184.559,
                    "leftEyeCornerRightX": 251.161,
                    "leftEyeCornerRightY": 191.076,
                    "rightEyeCornerLeftX": 306.043,
                    "rightEyeCornerLeftY": 192.545,
                    "rightEyeCornerRightX": 349.155,
                    "rightEyeCornerRightY": 191.896,
                    "rightEarTragusX": -1,
                    "rightEarTragusY": -1,
                    "leftEarTragusX": -1,
                    "leftEarTragusY": -1,
                    "leftEyeBrowLeftX": 192.648,
                    "leftEyeBrowLeftY": 163.369,
                    "leftEyeBrowMiddleX": 219.835,
                    "leftEyeBrowMiddleY": 157.958,
                    "leftEyeBrowRightX": 249.481,
                    "leftEyeBrowRightY": 173.279,
                    "rightEyeBrowLeftX": 300.299,
                    "rightEyeBrowLeftY": 173.451,
                    "rightEyeBrowMiddleX": 341.983,
                    "rightEyeBrowMiddleY": 162.189,
                    "rightEyeBrowRightX": 371.793,
                    "rightEyeBrowRightY": 172.751,
                    "nostrilLeftHoleBottomX": 252.914,
                    "nostrilLeftHoleBottomY": 257.574,
                    "nostrilRightHoleBottomX": 282.944,
                    "nostrilRightHoleBottomY": 261.791,
                    "nostrilLeftSideX": 240.333,
                    "nostrilLeftSideY": 253.962,
                    "nostrilRightSideX": 300.614,
                    "nostrilRightSideY": 256.05,
                    "lipCornerLeftX": 229.551,
                    "lipCornerLeftY": 290.118,
                    "lipLineMiddleX": 266.147,
                    "lipLineMiddleY": 288.209,
                    "lipCornerRightX": 311.985,
                    "lipCornerRightY": 294.562,
                    "pitch": 5.4466,
                    "yaw": 3.33709,
                    "roll": 4.90042
                }
            ]
        }
    ]
}]						
Enroll

Computes a biometric signature for a known face ("subject") in a picture and adds it to a collection ("gallery") for later searching. The subject id and gallery id must be supplied in addition to an image id reference from a previous Detect or Detect Features call. A subject id must be a globally unique identifier for each known individual identity for each API key. Subjects may exist in more than one gallery and can be added to or removed from a gallery with the Add To Gallery and Remove From Gallery functions. Adding multiple pictures of the same subject will help improve matching accuracy. Similarly, adding pictures of different people with the same subject id will negatively affect the accuracy of the matching algorithm. Enroll operations also require a face hint describing which face in a picture is to be enrolled. This may be in the form of face bounds (topLeftX, topLeftY, width, height) or eye coordinates (leftEyeCenterX, leftEyeCenterY, rightEyeCenterX, rightEyeCenterY). These landmarks may all be taken from the output of Detect or Detect Features calls.


Test console
Description
Parameter
string

a unique ID describing this person
Example: John_Doe

subject_id

Optional

string

a unique ID indicating the collection to which the person should be enrolled
Example: Family_Members

gallery_id

Optional

string

an image ID that was returned from a detect operation
Example: 7245253dbd2a142ceb40e031cb173734

image_id

Optional

number

X-Coordinate for top left corner of face. May be modified from Detect output.
Example: 105

topLeftX

Optional

number

Y-Coordinate for top left corner of face. May be modified from Detect output.
Example: 188

topLeftY

Optional

number

Width of face. May be modified from Detect output.
Example: 123

width

Optional

number

Height of face. May be modified from Detect output.
Example: 123

height

Optional

number

(required if face coordinates/dimensions omitted) X-Coordinate for the left eye center. May be modified from Detect output.
Example: 139.817

leftEyeCenterX

Optional

number

(required if face coordinates/dimensions omitted) Y-Coordinate for the left eye center. May be modified from Detect output.
Example: 160.727

leftEyeCenterY

Optional

number

(required if face coordinates/dimensions omitted) X-Coordinate for the right eye center. May be modified from Detect output.
Example: 198.365

rightEyeCenterX

Optional

number

(required if face coordinates/dimensions omitted) Y-Coordinate for the right eye center. May be modified from Detect output.
Example: 164.909

rightEyeCenterY

Optional

HTTP 200 : Image GET/list_galleries
Represents an image supplied to the api that has been processed. May contain zero or more faces.
						[{
    "images": [
        {
            "time": 2.98294,
            "status": "Complete",
            "url": "http://24.103.204.172/img/test/mk.jpg",
            "width": 600,
            "height": 582,
            "faces": [
                {
                    "topLeftX": 189,
                    "topLeftY": 149,
                    "width": 175,
                    "height": 175,
                    "leftEyeCenterX": 229.104,
                    "leftEyeCenterY": 186.917,
                    "rightEyeCenterX": 323.896,
                    "rightEyeCenterY": 192.021,
                    "noseTipX": 265.989,
                    "noseTipY": 246.91,
                    "noseBtwEyesX": 274.313,
                    "noseBtwEyesY": 190.021,
                    "chinTipX": 270.081,
                    "chinTipY": 312.169,
                    "leftEyeCornerLeftX": 212.891,
                    "leftEyeCornerLeftY": 184.559,
                    "leftEyeCornerRightX": 251.161,
                    "leftEyeCornerRightY": 191.076,
                    "rightEyeCornerLeftX": 306.043,
                    "rightEyeCornerLeftY": 192.545,
                    "rightEyeCornerRightX": 349.155,
                    "rightEyeCornerRightY": 191.896,
                    "rightEarTragusX": -1,
                    "rightEarTragusY": -1,
                    "leftEarTragusX": -1,
                    "leftEarTragusY": -1,
                    "leftEyeBrowLeftX": 192.648,
                    "leftEyeBrowLeftY": 163.369,
                    "leftEyeBrowMiddleX": 219.835,
                    "leftEyeBrowMiddleY": 157.958,
                    "leftEyeBrowRightX": 249.481,
                    "leftEyeBrowRightY": 173.279,
                    "rightEyeBrowLeftX": 300.299,
                    "rightEyeBrowLeftY": 173.451,
                    "rightEyeBrowMiddleX": 341.983,
                    "rightEyeBrowMiddleY": 162.189,
                    "rightEyeBrowRightX": 371.793,
                    "rightEyeBrowRightY": 172.751,
                    "nostrilLeftHoleBottomX": 252.914,
                    "nostrilLeftHoleBottomY": 257.574,
                    "nostrilRightHoleBottomX": 282.944,
                    "nostrilRightHoleBottomY": 261.791,
                    "nostrilLeftSideX": 240.333,
                    "nostrilLeftSideY": 253.962,
                    "nostrilRightSideX": 300.614,
                    "nostrilRightSideY": 256.05,
                    "lipCornerLeftX": 229.551,
                    "lipCornerLeftY": 290.118,
                    "lipLineMiddleX": 266.147,
                    "lipLineMiddleY": 288.209,
                    "lipCornerRightX": 311.985,
                    "lipCornerRightY": 294.562,
                    "pitch": 5.4466,
                    "yaw": 3.33709,
                    "roll": 4.90042
                }
            ]
        }
    ]
}]						
List Galleries

Lists the galleries that have been created by your personal API key.


HTTP 200 : Image GET/recognize
Represents an image supplied to the api that has been processed. May contain zero or more faces.
						[{
    "images": [
        {
            "time": 2.98294,
            "status": "Complete",
            "url": "http://24.103.204.172/img/test/mk.jpg",
            "width": 600,
            "height": 582,
            "faces": [
                {
                    "topLeftX": 189,
                    "topLeftY": 149,
                    "width": 175,
                    "height": 175,
                    "leftEyeCenterX": 229.104,
                    "leftEyeCenterY": 186.917,
                    "rightEyeCenterX": 323.896,
                    "rightEyeCenterY": 192.021,
                    "noseTipX": 265.989,
                    "noseTipY": 246.91,
                    "noseBtwEyesX": 274.313,
                    "noseBtwEyesY": 190.021,
                    "chinTipX": 270.081,
                    "chinTipY": 312.169,
                    "leftEyeCornerLeftX": 212.891,
                    "leftEyeCornerLeftY": 184.559,
                    "leftEyeCornerRightX": 251.161,
                    "leftEyeCornerRightY": 191.076,
                    "rightEyeCornerLeftX": 306.043,
                    "rightEyeCornerLeftY": 192.545,
                    "rightEyeCornerRightX": 349.155,
                    "rightEyeCornerRightY": 191.896,
                    "rightEarTragusX": -1,
                    "rightEarTragusY": -1,
                    "leftEarTragusX": -1,
                    "leftEarTragusY": -1,
                    "leftEyeBrowLeftX": 192.648,
                    "leftEyeBrowLeftY": 163.369,
                    "leftEyeBrowMiddleX": 219.835,
                    "leftEyeBrowMiddleY": 157.958,
                    "leftEyeBrowRightX": 249.481,
                    "leftEyeBrowRightY": 173.279,
                    "rightEyeBrowLeftX": 300.299,
                    "rightEyeBrowLeftY": 173.451,
                    "rightEyeBrowMiddleX": 341.983,
                    "rightEyeBrowMiddleY": 162.189,
                    "rightEyeBrowRightX": 371.793,
                    "rightEyeBrowRightY": 172.751,
                    "nostrilLeftHoleBottomX": 252.914,
                    "nostrilLeftHoleBottomY": 257.574,
                    "nostrilRightHoleBottomX": 282.944,
                    "nostrilRightHoleBottomY": 261.791,
                    "nostrilLeftSideX": 240.333,
                    "nostrilLeftSideY": 253.962,
                    "nostrilRightSideX": 300.614,
                    "nostrilRightSideY": 256.05,
                    "lipCornerLeftX": 229.551,
                    "lipCornerLeftY": 290.118,
                    "lipLineMiddleX": 266.147,
                    "lipLineMiddleY": 288.209,
                    "lipCornerRightX": 311.985,
                    "lipCornerRightY": 294.562,
                    "pitch": 5.4466,
                    "yaw": 3.33709,
                    "roll": 4.90042
                }
            ]
        }
    ]
}]						
Recognize

Matches an unknown face against a collection ("gallery") of known faces. Galleries are built using the Enroll function. Response includes a similarity score between 0 and 1 for all closely matching subjects in the gallery. A gallery id must be supplied in addition to an image id reference from a previous Detect or Detect Features call. Recognize operations require a face hint describing which face in a picture is to be enrolled. This may be in the form of face bounds (topLeftX, topLeftY, width, height) or eye coordinates (leftEyeCenterX, leftEyeCenterY, rightEyeCenterX, rightEyeCenterY). These landmarks may all be taken from the output of Detect or Detect Features calls.


Test console
Description
Parameter
string

a unique ID indicating the collection which this unknown person should be compared against
Example: Family_Members

gallery_id

Optional

string

an image ID that was returned from a detect operation
Example: 7245253dbd2a142ceb40e031cb173734

image_id

Optional

number

X-Coordinate for top left corner of face. May be modified from Detect output.
Example: 105

topLeftX

Optional

number

Y-Coordinate for top left corner of face. May be modified from Detect output.
Example: 188

topLeftY

Optional

number

Width of face. May be modified from Detect output.
Example: 123

width

Optional

number

Height of face. May be modified from Detect output.
Example: 123

height

Optional

number

(required if face coordinates/dimensions omitted) X-Coordinate for the left eye center. May be modified from Detect output.
Example: 139.817

leftEyeCenterX

Optional

number

(required if face coordinates/dimensions omitted) Y-Coordinate for the left eye center. May be modified from Detect output.
Example: 160.727

leftEyeCenterY

Optional

number

(required if face coordinates/dimensions omitted) X-Coordinate for the right eye center. May be modified from Detect output.
Example: 198.365

rightEyeCenterX

Optional

number

(required if face coordinates/dimensions omitted) Y-Coordinate for the right eye center. May be modified from Detect output.
Example: 164.909

rightEyeCenterY

Optional

You must have an API key to test this API!


Mashape allows developers to find, consume, and distribute cloud APIs just like Animetrics Face Recognition.

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.