Sign in

v5

latestSwagger 2.02026-07-136680294.1 KB

Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List.

get/facelists/{faceListId}

Path parameters

faceListIdstring required

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

Query parameters

returnRecognitionModelboolean

Return 'recognitionModel' or not. The default value is false.

Response

A successful call returns the Face List's information.

namestring required

User defined name, maximum length is 128.

userDatastring

Optional user defined data. Length should not exceed 16K.

recognitionModel'recognition_01' | 'recognition_02' | 'recognition_03' | 'recognition_04'

The recognition model for the face.

faceListIdstring required