GUgumnut-ai
people

Update a person

Changed on

Updates a person's name, birth date, visibility, favorite status, or thumbnail. Supplied values overwrite current metadata; there is no automatic undo. Omitted fields are unchanged. Does not delete the person or face detections. Renaming to another record's name in the same library, including hidden people returns 409. Names ignore case and surrounding whitespace; retrying the same collision does not resolve it. Typical use: assigning a name ('name this face cluster "Alice"') or choosing a better thumbnail.

This tool does not move faces between people — use update_face with a new person_id for that.

bulk_update_people applies changes to multiple people in one call.

patch/api/people/{person_id}

Request

  • Base URL
    https://api.gumnut.ai
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

person_idstring required

Person ID (with person_ prefix) of the person to update.

Request body

namestring nullable

New display name; must not be blank. Surrounding whitespace is trimmed. Omit to leave unchanged; pass null to clear the name.

birth_datestring date nullable

New birth date (ISO 8601 date). Omit to leave unchanged.

is_hiddenboolean

Hide or unhide this person. Omit to leave unchanged.

is_favoriteboolean

Mark or unmark this person as a favorite. Omit to leave unchanged.

thumbnail_face_idstring nullable

New thumbnail face ID for this person. Omit to leave unchanged. Enumerate a person's faces with list_faces and person_id.

Response

Successful Response

idstring required

Unique person identifier with 'person_' prefix

namestring nullable

Name assigned to this person, or null when unnamed. Names supplied as text on create or update are trimmed and must not be blank.

birth_datestring date nullable

Optional birth date of this person

is_hiddenboolean required

Whether this person should be hidden from the UI

is_favoriteboolean required

Whether this person is marked as a favorite

asset_countinteger nullable

Number of unique photos this person appears in, by a face or a body linked to them, or null if not computed

thumbnail_face_idstring nullable

ID of the face resource used as this person's thumbnail

asset_urlsobject nullable

Asset variants from this person's thumbnail face. May be null when embedded in an AssetResponse; use /api/people endpoints for full person data.

created_atstring date-time required

When this person record was created

updated_atstring date-time required

When this person record was last updated

Changes

  • 7c2860d9eb88Revision changes
    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the / request property's minLength was increased from 0 to 1

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 815e0302a988Revision changes
    • breaking

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

    • info

      the response property became required for the status