API Reference

Enroll a face into a collection

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

Enroll a single face into a collection by providing an image URL, base64-encoded image, or a file upload (multipart/form-data). The image must contain exactly one face. If no face or multiple faces are detected, an error is returned. You can optionally provide a name, external_id, and metadata for the enrolled face.

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

string

Base64 strict encoded image data (max 20MB decoded)

file

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

string

Name or label for the enrolled face (max 255 characters)

string

External reference ID for your system (max 255 characters)

metadata
object

Additional metadata to store with the face (max 16KB)

Responses

400

No face detected or multiple faces detected in 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