Skip to content

Using REST Operations

Periodic evaluation of facial recognition data can be acheived with simple POST operations to the SETI API. This section of the API documentation details the available operations.

Match (POST)

The Match operation accepts two JPEG File parameters representing two independant instances of an individual face. This operation is typically used to compare a current instance of a user's face from a capture device to that of a known instance creating during a registration process such as an account creation. The Match operation uses a proprietary machine learning process to extrapolate the facial features from each provided instance and compares them. It then returns an object representing the percentage of confidence that the two instances are representitive of the same individual.

Input

Argument Type Description
file1 JPEG File A JPEG File for reference
file2 JPEG File A JPEG File for comparison

Output

{"MatchPercentage":96.856}

Example (curl)

curl -X POST -F "file1=@file1.jpg" -F "file2=@file2.jpg" https://facesdk.app.getsmarteye.mobi/match

Faces (POST)

The Faces operation accepts a single JPEG file input and returns an object representing the count of faces detected within the image. This operation is commonly used for security features where only a single user is expected to be within the area viewable by a capture device.

Note: Some clients (such as Python's request) may need to indicate the single image named 'file' inside an array of 'files'. This is intentional to provide for use of the operation in HTML clients

Input

Argument Type Description
file JPEG File A JPEG File evaluation

Output

{"Faces":2}

Example (curl)

curl -X POST -F "file=@file.jpg"  https://facesdk.app.getsmarteye.mobi/faces

Faces (POST)

The Faces operation accepts a single JPEG file input and returns an object representing the count of faces detected within the image. This operation is commonly used for security features where only a single user is expected to be within the area viewable by a capture device.

Note: Some clients (such as Python's request) may need to indicate the images named 'file1' and 'file2' inside an array of 'files'. This is intentional to provide for use of the operation in HTML clients

Input

Argument Type Description
file JPEG File A JPEG File evaluation

Output

{"Faces":2}

Example (curl)

curl -X POST -F "file=@file.jpg"  https://facesdk.app.getsmarteye.mobi/faces