iLive Docs
API ReferenceFace Services

List Faces

GET
/api/v2/collections/{external_id}/faces
/api/v2/collections/{external_id}/faces

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Path Parameters

external_id
Required
External Id

Query Parameters

external_image_idExternal Image Id

cursorCursor

limitLimit

Default: 50Minimum: 1Maximum: 200
curl -X GET "https://docs.localhost:8543/api/v2/collections/string/faces?external_image_id=string&cursor=string&limit=50" \
  -H "Authorization: Bearer <token>"

Successful Response

{
  "faces": [
    {
      "face_id": "string",
      "external_image_id": "string",
      "external_face_id": "string",
      "bounding_box": {
        "left": 0,
        "top": 0,
        "width": 0,
        "height": 0
      },
      "attributes": {}
    }
  ],
  "next_cursor": "string"
}

Previous

Index Faces POST

Next

Delete Face DELETE