faces

Delete a face detection

Changed on

Removes one face detection row; the underlying asset and the person this face was assigned to are both preserved.

Use update_face with person_id=null instead when the user wants to disassociate the face from a person without discarding the detection (so re-clustering can try again). Use delete_person to remove a person; use trash_assets to remove the photo entirely.

delete/api/faces/{face_id}

Request

  • Base URL: https://api.gumnut.ai
  • URL: https://api.gumnut.ai/api/faces/{face_id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

face_idstring required

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

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.

Response

Successful Response

DeletionResponse required

Empty acknowledgment returned when an operation succeeds.

Changes

  • 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

  • c3e15c78f2daRevision changes
    • info

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status