API

FPT.AI Reader - Face Search

Input requirements

  • Image format must be jpg or jpeg

  • Size of the input image must not surpass 5 MB with minimum resolution around 640x480 to ensure accuracy rate

  • Face must take up at least ¼ of the total image area.

Qualified image sample

1

Unqualified images

  • Low-quality images or images with the face covered

API Information

1. Create user on the system (to add index images)

Request Url

POST https://api.fpt.ai/dmp/facesearch/v2/create

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Body

FormData contains the collection name and user information (id, name)

ParameterRequirementDescription
collectionyeseach collection will be indexed and searched separately
idyesuser id must be unique
nameyes

Sample Request

curl --location --request POST 'https://api.fpt.ai/dmp/facesearch/v2/create' \\

\--header 'api_key: xxxxxxxxxxxxxxxx' \\

\--form 'collection=test2' \\

\--form 'id=1234' \\

\--form 'name=Nam'

Response

JSON

{

"data": "User created/updated",

"code": "200"

}

Response Code

Codemeaning
200User created/updated

Sample Response: Success

{

"data": "User created/updated",

"code": "200"

}

2. Index user images

Request Url

POST https://api.fpt.ai/dmp/facesearch/v2/add

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Body

FormData contains the collection name, user id, and face image

ParameterRequirementDescription
collectionyeseach collection will be indexed and searched separately
idyesuser id created
fileyesface detected
allow_id_cardnotrue/false: allow id card image

Sample Request

curl --location --request POST 'https://api.fpt.ai/dmp/facesearch/v2/add' \\

\--header 'api_key: xxxxxxxxxxxxxxxx' \\

\--form 'file=\@/path/to/photo.jpg' \\

\--form 'collection=test2' \\

\--form 'id=1234'

Response

JSON

{

"data": "Add photo success",

"code": "200"

}

Response Code

Codemeaning
200Image index successs
400Wrong format / Multiple faces / No face detected
406Face covered with mask, hat, or sunglasses
410Photo is id card

Sample Response: Success

{

"data": "Add photo success",

"code": "200"

}

Sample Response: Error

{

"data": "No face detected",

"code": "400"

}

{

"data": "Photo is id card",

"code": "410"

}

3. Facesearch

Request Url

POST https://api.fpt.ai/dmp/facesearch/v2/search

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Body

FormData contains the collection name, and the face image to be searched

ParameterRequirementDescription
collectionyeseach collection will be indexed and searched separately
fileyesface detected
thresholdnoThe default threshold for identification of 2 similar faces is 0.85
allow_id_cardnotrue/false: allow id card image

Sample Request

curl --location --request POST 'https://api.fpt.ai/dmp/facesearch/v2/search' \\

\--header 'api_key: xxxxxxxxxxxxxxxx' \\

\--form 'file=\@/path/to/search_photo.jpg' \\

\--form 'collection=test2' \\

\--form 'threshold=0.9'

Response

JSON

{

"data": {

"id": "1234",

"name": "Nam",

"similarity": 0.9999998807907104

},

"code": "200"

}

Response Code

Codemeaning
200Image index successs
400Wrong format / Multiple faces / No face detected
404Not found
406Face covered with mask, hat, or sunglasses
410Photo is id card

Sample Response: Success

{

"data": {

"id": "1234",

"name": "Nam",

"similarity": 0.9999998807907104

},

"code": "200"

}

Sample Response: Error

{

"data": "No face detected",

"code": "400"

}

{

"data": "Photo is id card",

"code": "410"

}

{

"data": "Not found",

"code": "404"

}

4. Remove face data (not delete the user)

Request Url

DELETE https://api.fpt.ai/dmp/facesearch/v2/delete_faces

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Body

FormData contains the collection name and user id

ParameterRequirementDescription
collectionyescollection name
idyesthe id of user

Sample Request

curl --location --request DELETE 'https://api.fpt.ai/dmp/facesearch/v2/delete_faces' \
--header 'api_key: xxxxxx' \
--form 'collection="test1"' \
--form 'id="2"'

Response

JSON

{
    "data": "User faces deleted",
    "code": "200"
}

Response Code

Codemeaning
200Faces delete success
404User not found

5. Delete user

Request Url

DELETE https://api.fpt.ai/dmp/facesearch/v2/delete

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Body

FormData contains the collection name and user id

ParameterRequirementDescription
collectionyescollection name
idyesthe id of user

Sample Request

curl --location --request DELETE 'https://api.fpt.ai/dmp/facesearch/v2/delete' \
--header 'api_key: xxxxxxxx' \
--form 'collection="test2"' \
--form 'id="1234"'

Response

JSON

{
    "data": "User deleted",
    "code": "200"
}

Response Code

Codemeaning
200User delete success
404User not found

6. List users in collection

Request Url

GET https://api.fpt.ai/dmp/facesearch/v2/list

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Params

Request string contains the collection name

ParameterRequirementDescription
collectionyesThe collection name that want to list users

Sample Request

curl --location --request GET 'https://api.fpt.ai/dmp/facesearch/v2/list?collection=test1' \
--header 'api_key: xxxxxx' \

Response

JSON

{
    "data": [
        {
            "id": "1",
            "name": "Nguyen Van A"
        },
        {
            "id": "3",
            "name": "Nguyen Van B"
        }
    ],
    "code": "200"
}

Response Code

Codemeaning
200Request success

7. Delete collection

Request Url

DELETE https://api.fpt.ai/dmp/facesearch/v2/delete_collection

Request Headers

ParameterRequirementDefaultDescription
api_keyYesyour api_key (from console.fpt.ai)

Request Body

FormData contains the collection name

ParameterRequirementDescription
collectionyescollection name

Sample Request

curl --location --request DELETE 'https://api.fpt.ai/dmp/facesearch/v2/delete_collection' \
--header 'api_key: xxxxxx' \
--form 'collection="test1"'

Response

JSON

{
    "data": "Remove collection success",
    "code": "200"
}

Response Code

Codemeaning
200Collection delete success
404Collection not found
← Passport RecognitionFacematch →