API Reference

Search for faces in a collection

post
https://api.bynn.com/v1/face-collections//search

Search for similar faces in a collection by providing a probe image (URL, base64, or file upload). Returns matching faces ordered by similarity (lowest distance first). If the image contains multiple faces, the largest/first detected face is used for the search.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Collection token (e.g. fc_abc123)

Body Params
string

URL of the image containing a face to search for

string

Base64 strict encoded image data (max 20MB decoded)

file

Image file upload (multipart/form-data, max 20MB)

int32
1 to 100
Defaults to 10

Maximum number of results to return (1-100)

float
Defaults to 0.5

Maximum cosine distance threshold for matches (0.1-1.0, lower is stricter)

Responses

400

No face detected in probe image

401

Unauthorized - Invalid or missing API key

404

Collection not found

422

Validation error - Invalid input

429

Rate limit exceeded

Updated about 2 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago