GUgumnut-ai
people

Merge people

Changed on

Merges one or more source people into the primary person identified by the URL. All faces and bodies from source people are reassigned to the primary person. Source people are permanently deleted (this cannot be undone).

In the degenerate case where the primary and all sources are unnamed and have zero faces, the primary is deleted too, its bodies are left with no person, and the response is 204 No Content.

post/api/people/{person_id}/merge

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 primary person that absorbs the source people. Person IDs are carried by the id field of person responses (e.g. list_people, get_person) and by person references on faces and assets.

Request body

source_person_idsstring[] required

IDs of the people to merge into the primary person. These people will be deleted after their faces are moved.

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
    • 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