iLive Docs
API ReferenceFace Services

Search By Face

POST
/api/v2/collections/{external_id}/search-by-face/{face_id}
/api/v2/collections/{external_id}/search-by-face/{face_id}

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Path Parameters

external_id
Required
External Id

face_id
Required
Face Id

Query Parameters

max_resultsMax Results

Default: 10Minimum: 1Maximum: 100

thresholdThreshold

curl -X POST "https://docs.localhost:8543/api/v2/collections/string/search-by-face/string?max_results=10&threshold=0" \
  -H "Authorization: Bearer <token>"

Successful Response

{
  "matches": [
    {
      "face_id": "string",
      "similarity": 0,
      "external_image_id": "string",
      "external_face_id": "string",
      "bounding_box": {
        "property1": 0,
        "property2": 0
      }
    }
  ],
  "searched_face": {
    "left": 0,
    "top": 0,
    "width": 0,
    "height": 0
  },
  "threshold": 0
}

Previous

Search By Image POST

Next

Get Captcha Config GET