Skip to main content
POST
Generate an embedding for one image

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

img
string
required

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.

model_name
string

Approved model name from the current allowlist. For /verify and /represent, omitted, blank, or overlong values are treated as absent and the gateway injects the active default model.

Maximum string length: 200
Example:

"Facenet"

detector_backend
string

Optional detector backend from the current allowlist. When the active detector misses a face, the service may retry configured fallback detectors before returning no_face_detected.

Example:

"opencv"

enforce_detection
boolean
default:true
align
boolean
default:true
normalization
string

Optional DeepFace normalization mode.

Response

Embedding response

embedding
number[]
required
model_name
string
required
facial_area
object
face_confidence
number