Compare image and vector pairs without storing embeddings

POST /compare

Compare image and vector pairs without storing embeddings

cURL

curl --request POST \
  --url https://deepface-cyybxg.fly.dev/compare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model_name": "Facenet",
  "vector": [
    123
  ]
}
'

200

{
  "model_name": "<string>",
  "metric": "cosine",
  "source": {
    "type": "image",
    "vector_length": 123,
    "face_index": 123
  },
  "results": [
    {
      "index": 123,
      "distance": 123,
      "id": "<string>",
      "match": true
    }
  ],
  "threshold": 123,
  "best_match": {
    "index": 123,
    "distance": 123,
    "id": "<string>",
    "match": true
  }
}

Authorizations

BearerAuthApiKeyHeader

Authorization · string · header · required

Use your API key as a bearer token.

Headers

x-request-id · string<uuid>

Optional UUID used for request tracing.

Body

application/jsonmultipart/form-data

model_name · string · required

Example:

"Facenet"

img · string

Base64 image payload or data URL.

source_vector · number[]

vector · number[] (number[] | object)[]

target_vector · number[]

target_vectors · (number[] | object)[]

vectors · (number[] | object)[]

vector_b · number[]

distance_metric · enum<string> · default: cosine

Available options: cosine, euclidean, euclidean_l2

metric · enum<string>

Available options: cosine, euclidean, euclidean_l2

threshold · number

detector_backend · string

enforce_detection · boolean

align · boolean

normalization · string

face_index · integer · default: 0

Response

200

application/json

Compare result

model_name · string · required

metric · enum<string> · required

Available options: cosine, euclidean, euclidean_l2

source · object · required

Show child attributes

results · object[] · required

Show child attributes

threshold · number | null

best_match · object

Show child attributes