Delete Faces from Collection

API reference

curl -X POST "https://__mock__/delete_faces_from_collection" \  -H "Content-Type: application/json" \  -d '{    "bucket": "string",    "external_image_id": "string"  }'

{
  "success": true,
  "response": {}
}

{
  "msg": "string"
}

{
  "detail": {},
  "message": "string"
}

Overview

Call POST /delete_faces_from_collection with Authorization: Bearer <token> and application/json. Required fields are bucket and external_image_id.

Key features

• Privacy and cleanup: Removes stored face metadata when a user withdraws consent or when you retire stale records.

Implementation

Step 1: Build the JSON payload

Set required bucket and external_image_id to match the face record you indexed.

Step 2: Send the request from your backend

POST /delete_faces_from_collection HTTP/1.1
Host: <machine-learning-api-base-url>
Authorization: Bearer <token>
Content-Type: application/json

Step 3: Handle the response

On 200 OK, read success and response. On 400, read msg.

Error handling

Benefits

• Supports data-minimization and retention policies for biometric data.

Next steps

• Index faces
• API Suite index