Documentation

Get FaceSet API

Call this API to get the info of a faceSet.

Request Example:

curl -X GET \
  https://sg-api.advance.ai/intl/openapi/face-search/facesets?id=1 \
  -H 'X-ACCESS-TOKEN:{Your Access Token}'

Request Url

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

Request Parameters

ParameterDescription
idstring the unique id of the faceSet.

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.
dataobject The faceSet info. Refer to faceSet.
extraobject Extra response info (Exception Message).

Response Code

Status CodeMessage
SUCCESSfree OK.
PARAMETER_ERRORfree Parameter error, please check your request whether has illegal parameters.
ERRORfree Server error.

Response Examples

SUCCESS

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

PARAMETER_ERROR

{
    "code": "PARAMETER_ERROR",
    "message": "FaceSet not found, id: 1",
    "data": null,
    "extra": null,
    "pricingStrategy": "FREE"
}