API referenceCollections
Delete one photo's faceprints (soft by default, restorable)
Deletes the face vectors indexed from one photo (by the photoId you supplied at index time), without… (DELETE /v1/collections/{id}/photos/{photoId})
DELETE
/v1/collections/{id}/photos/{photoId}- Auth
- Bearer API key
- Billing
- free (0 credits).
Deletes the face vectors indexed from one photo (by the photoId you
supplied at index time), without touching the rest of the collection.
Synchronous and free. Idempotent — deleting an already-removed photo
still returns 200.
Two modes, mirroring the collection delete:
- Soft (default, no flag) — the faces are tagged deleted and drop out
of search immediately, but the vectors survive the grace window so the
delete can be undone with
POST /v1/collections/{id}/photos/{photoId}/restore. This is the safe default: an accidental delete from your own automation is recoverable. - Immediate (
?immediate=true) — the vectors are physically removed now. NOT restorable.
?compliance=true is an alias for immediate=true that additionally
records the erasure as compliance-class for your own audit trail.
Example request
curl -X DELETE "https://api.sightradar.com/v1/collections/$ID/photos/$PHOTOID" \
-H "Authorization: Bearer $SR_API_KEY"Parameters
| Name | In | Type | Description |
|---|---|---|---|
id required | path | string | Collection id. |
photoId required | path | string | The photoId supplied at index time. |
immediate | query | boolean | Physically delete the vectors now instead of soft-deleting them. Not restorable. |
compliance | query | boolean | Alias for immediate=true, additionally recorded as a compliance-class erasure. |
Response body
| Field | Type | Description |
|---|---|---|
deleted | boolean | |
collection_id | string | |
photo_id | string | |
mode | "soft" | "immediate" | Which delete mode was applied. |
restorable | boolean | True for a soft delete (undo via the restore endpoint); false for an immediate delete. |
Status codes
| Status | Meaning |
|---|---|
200 | Faceprints deleted. |
401 | Missing or invalid API key. |
404 | Resource not found. |
502 | Deletion service unavailable. |
Last updated