Skip to main content
POST
/
compare
Compare image and vector pairs without storing embeddings
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
  ]
}
'
{
  "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

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

model_name
string
required
Example:

"Facenet"

img
string

Base64 image payload or data URL.

source_vector
number[]
vector
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

Compare result

model_name
string
required
metric
enum<string>
required
Available options:
cosine,
euclidean,
euclidean_l2
source
object
required
results
object[]
required
threshold
number | null
best_match
object