Skip to main content
POST
Compare image and vector pairs without storing embeddings

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
Maximum string length: 200
Example:

"Facenet"

img
string

Base64 image payload or data URL. The managed API rejects images that exceed the active byte, request-size, or decoded pixel safety limits before forwarding work to the model runtime.

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