Sign in

v2

latestSwagger 2.02026-07-138076216.6 KB

List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).

get/largefacelists/{largeFaceListId}/persistedfaces

Path parameters

largeFaceListIdstring required

Id referencing a particular large face list.

Query parameters

startstring

Starting face id to return (used to list a range of faces).

topinteger

Number of faces to return starting with the face id indicated by the 'start' parameter.

Response

A successful call returns an array of face information that belong to the large face list.

persistedFaceIdstring uuid required

The persistedFaceId of the target face, which is persisted and will not expire. Different from faceId created by Face - Detect and will expire in at the time specified by faceIdTimeToLive after the detection call.

userDatastring

User-provided data attached to the face. The size limit is 1KB.