Search By Image

POST

/api/v2/collections/{external_id}/search-by-image

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

multipart/form-dataRequired

`image`
Required
Image

Format: "binary"

`max_results`Max Results

Default: 10

`threshold`Threshold

Path Parameters

`external_id`
Required
External Id

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

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
}

Search By Image

Authorization

AuthorizationRequiredBearer <token>

Request Body

imageRequiredImage

max_resultsMax Results

thresholdThreshold

Path Parameters

external_idRequiredExternal Id

Response

TypeScript

`Authorization`
Required
Bearer <token>

`image`
Required
Image

`max_results`Max Results

`threshold`Threshold

`external_id`
Required
External Id