Documentation

List FaceSet API

Call this API to list all faceSets.

Request Example:

curl -X GET \
  https://sg-api.advance.ai/intl/openapi/face-search/facesets/list \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' 

Request Url

https://sg-api.advance.ai/intl/openapi/face-search/facesets/list
GET
ParameterDescription
X-ACCESS-TOKENstring Please use Token Authentication API to get your access token.

Response Description

ParameterDescription
codeenum Status Code.
transactionIdstring The request id, the max length is 64.
pricingStrategyenum Whether the request will be charged, enum type: FREE, PAY.
messagestring The error message used to debug.
datalist The list of faceSet object.
extraobject Extra response info (Exception Message).

faceSet

ParameterDescription
idstring The unique id of the faceSet.
createdAtstring The create time of the faceSet. in the format of ISO 8601 .
lastUpdatedAtstring The last update time of the faceSet. in the format of ISO 8601 .
deletedAtstring The deleted time of the faceSet. in the format of ISO 8601 .
namestring The name of the faceSet.
countrystring The alpha-2 country code. Refer to ISO ALPHA-2 Country Code .

Response Code

Status CodeMessage
SUCCESSfree OK
ERRORfree Server error

Response Examples

ISO 8601

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": [
        {
            "id": "66b33063e0ecb052f932bea4",
            "createdAt": "2024-08-07T08:29:23.061",
            "lastUpdatedAt": "2024-08-07T08:29:25.72",
            "deletedAt": null,
            "name": "Faces Collection",
            "country": "SG"
        }
    ],
    "extra": null
}