Skip to main content
PATCH
Update a body

Authorizations

Authorization
string
header
required

Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.

Path Parameters

body_id
string
required

Body ID (with body_ prefix) of the body to update.

Query Parameters

library_id
string | null

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

Body

application/json
person_id
string | null
required

Person ID (with person_ prefix) to link this body to, or null to remove its person; the body stays, with no person.

Response

Successful Response

A person found in an asset without a face record.

id
string
required

Unique body identifier with 'body_' prefix

asset_id
string
required

ID of the asset containing this body

person_id
string | null
required

ID of the person this body is linked to, or null when it has none yet.

assignment_source
enum<string> | null
required

'automatic' when Gumnut linked the person, 'manual' when someone with edit access to the library did. null when person_id is null.

Available options:
automatic,
manual
bounding_box
Bounding Box · object
required

Where the person is, as {x, y, w, h} in pixels: (x, y) is the box's top-left corner and w, h its size, on the image as displayed (EXIF orientation applied), so they match the asset's width and height

created_at
string<date-time>
required

When this body was detected

updated_at
string<date-time>
required

When this body record was last updated