Skip to main content
POST
/
v3
/
faces
Create a new Equos Face.
curl --request POST \
  --url https://api.equos.ai/v3/faces \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "identity": "tommy",
  "client": "<string>"
}
'
{
  "id": "<string>",
  "identity": "tommy",
  "organizationId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "client": "<string>",
  "description": "<string>",
  "thumbnailUrl": "<string>",
  "referenceImgUrl": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
identity
enum<string>
required

Identity of the face in Equos Gallery.

Available options:
tommy
client
string | null

Client identifier associated with the face. This is useful to segment resources by client.

Response

201 - application/json
id
string
required
identity
enum<string>
required
Available options:
tommy
organizationId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
client
string | null
description
string | null
thumbnailUrl
string | null
referenceImgUrl
string | null