v5

latestSwagger 2.02026-07-136680294.1 KB

List faces' persistedFaceId and userData in a specified Large Face List.

Faces are stored in alphabetical order of persistedFaceId created in "Add Large Face List Face".

    • "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
    • "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.

[!TIP]

  • For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
    • "start=&top=" will return all 5 items.
    • "start=&top=2" will return "itemId1", "itemId2".
    • "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".
get/largefacelists/{largeFaceListId}/persistedfaces

Path parameters

largeFaceListIdstring required

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

Query parameters

startstring

List resources greater than the "start". It contains no more than 64 characters. Default is empty.

topinteger

The number of items to list, ranging in [1, 1000]. Default is 1000.

Response

A successful call returns an array of persisted faces and their information (persistedFaceId and userData).

persistedFaceIdstring uuid required

Universally Unique Identifier

userDatastring

User-provided data attached to the face. The length limit is 1K.