Sign in
Faces

Retrieve faces for asset

Changed on

Retrieve all faces belonging to an asset.

get/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

Query parameters

idstring uuid required

Face ID

Response

boundingBoxX1integer required

Bounding box X1 coordinate

boundingBoxX2integer required

Bounding box X2 coordinate

boundingBoxY1integer required

Bounding box Y1 coordinate

boundingBoxY2integer required

Bounding box Y2 coordinate

idstring uuid required

Face ID

imageHeightinteger required

Image height in pixels

imageWidthinteger required

Image width in pixels

sourceType'machine-learning' | 'exif' | 'manual'

Face detection source type

Changes

  • 2cd7bd44a940Revision changes
    • info

      the ////// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status