Delete a photo's faces
delete_photoRemove every indexed face from a single photo. Use default soft deletion for reversal, or set immediate/compliance for permanent erasure.
Instructions
Remove every face indexed from one photo. Soft by default (restore_photo undoes it); immediate=true or compliance=true is permanent. Deleting a photo that is already gone, or a photo_id that was never indexed, still answers deleted=true, so check the photo_id before telling the user something was removed. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| photo_id | Yes | The photo_id used when the photo was indexed. | |
| immediate | No | Remove permanently now. | |
| compliance | No | Audited legal erasure. Permanent. | |
| collection_id | Yes | Collection id, e.g. an event or album id. Any text except '/', '\', '.' and '..'. |