Add Image to Database | Face Search API | Post Request

Overview

Face Search allows you to add images and register people directly into your online image database using an API call. This API would be useful when you do not have a database of images of the people you need to recognize and wish to add the users one at a time.

This API accepts image files which contain only 1 face and the accuracy of the search results will depend on the quality of a person’s registered image.

Image Requirement

  1. Please refer to the article “Image Quality for Facial Recognition” for best practices.
  2. We recommend an image resolution no higher than 1024x, since it could slow down the request process. Supported image formats are JPEG/PNG format.

Request URL

https://search.facex.io:8443/images/singleImage/

Header

Fields
Type
Description
content-type String multipart/form-data

 

Body

Fields

Type

Description

image file An image file, supported files jpeg, png
user_id String Your valid User ID

(as shown in your user portal when you log in)

name String Name/ ID of the person you wish to register

Note: Your User ID will be valid for this API only if you have an active Face Search plan

Result

The following response will be sent by the server once the image is registered.
{
“status”: “ok”,
“code”: “1000”,
“success”: true,
“message”: “Added image to batch.”,
“data”: {
“image_id”: “5bbbbBbbbBbBBbbbbbbbbbbB”
}
}
Related Articles
Post a Comment