Sign in
faces

Update a face

Assigns a face to a specific person, or detaches it from its current person (set person_id to null). This is the right tool for 'this face is Alice' or 'this face isn't Bob after all'.

Currently only the person_id field is mutable. To create a brand-new identity first, call create_person; to delete the face detection entirely, use delete_face.

patch/api/faces/{face_id}

Path parameters

face_idstring required

Face ID (with face_ prefix) of the face detection to update.

Face ID (with face_ prefix) of the face detection to update.

Query parameters

library_idstring nullable

Library the face belongs to. Optional if the user has a single live (non-trashed) library; required when they have multiple.

Library the face belongs to. Optional if the user has a single live (non-trashed) library; required when they have multiple.

Request body

person_idstring nullable

Target person ID (with person_ prefix) to assign this face to. Pass null to detach the face from its current person without deleting either. Use create_person first if the target identity doesn't exist yet.

Response

Successful Response

idstring required

Unique face identifier with 'face_' prefix

asset_idstring required

ID of the asset containing this face

person_idstring nullable

ID of the person this face belongs to (if identified)

bounding_boxobject required

Face location as {x, y, w, h} coordinates in pixels

confidencenumber nullable

Detector confidence on a 0-1 scale; higher is more confident among faces detected under the same configuration (values are not comparable across detector generations). Null on legacy faces without a stored score and on manually added faces.

source'automatic' | 'manual' required

How this face was added: 'automatic' for detector-found faces, 'manual' for user-drawn face boxes.

timestamp_msinteger nullable

For video files, timestamp in milliseconds when face appears

asset_urlsobject nullable

Asset variants for this face: 'thumbnail' with face crop

created_atstring date-time required

When this face was detected and recorded

updated_atstring date-time required

When this face record was last updated

Changes

Changed in 3 of the 79 revisions of this API.17

  • 815e0302a98811See the full diff
    • ▲

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

      response-property-list-of-types-widened

    • ○

      the response property detail became required for the status 422

      response-property-became-required

  • c3e15c78f2da4See the full diff
    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 0af8aaa9fea32See the full diff
    • ○

      added the optional property confidence to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property source to the response with the 200 status

      response-required-property-added