Call this API to delete a face.

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/face-search/facereferences/delete \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' \
  -d  '{
    "id": "1",
    "faceSetId": "1"
}'

Request Url

https://sg-api.advance.ai/intl/openapi/face-search/facereferences/delete
POST (application/json)

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token.

Request Parameters

Parameter	Description
id	`string` the unique id of the face.
faceSetId	`string` the unique id of the faceSet owns the face.

Response Description

Parameter	Description
code	`enum` Status Code.
transactionId	`string` The request id, the max length is 64.
pricingStrategy	`enum` Whether the request will be charged, enum type: `FREE`, `PAY`.
message	`string` The error message used to debug.
data	`string` The id of the deleted face.
extra	`object` Extra response info (Exception Message).

Response Code

Status Code	Message
SUCCESS	`free` OK.
PARAMETER_ERROR	`free` Parameter error, please check your request whether has illegal parameters.
ERROR	`free` Server error.

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": "1",
    "extra": null
}

PARAMETER_ERROR

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