Sign in
Faces

Create a face

Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face.

post/faces

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/faces
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Request body

assetIdstring uuid required

Asset ID

heightinteger required

Face bounding box height

imageHeightinteger required

Image height in pixels

imageWidthinteger required

Image width in pixels

personIdstring uuid required

Person ID

widthinteger required

Face bounding box width

xinteger required

Face bounding box X coordinate

yinteger required

Face bounding box Y coordinate

Changes

No recorded changes to this operation across all 50 revisions of this API.