Documentation

Create FaceSet API

Call this API to create a faceSet.

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/face-search/facesets \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' \
  -d '{
    "name": "Faces Collection-q",
    "country": "SG",
}'

Request Url

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

Request Parameters

ParameterDescription
namestring Supports letters, numbers, underscores, and hyphens, with a length of no more than 32 characters.
countrystring The alpha-2 country code. Refer to ISO ALPHA-2 Country Code

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.
datastring The faceSet id created.
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": "1",
    "extra": null
}

PARAMETER_ERROR

{
    "code": "PARAMETER_ERROR",
    "message": "FaceSet with same name already exists, name: Faces",
    "data": null,
    "extra": null,
    "pricingStrategy": "FREE"
}