GUgumnut-ai
people

Get a person

Changed on

Fetches one person's metadata by ID (name, asset count, thumbnail, etc.). Use this when you already have a person_id. The JSON response is metadata only; to get the photos that contain this person, use search_assets with person_ids or list_assets with person_ids.

get/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) to fetch. Carried by the person_id field on a face and by the entries of an asset's people field (returned with include=people).

Query parameters

includestring[] nullable

Opt-in expansion fields. See list_people for supported values. Accepts multiple include= query params or a single comma-delimited value.

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