API referenceCollections
Create a collection
Creates a new face collection owned by your account. (POST /v1/collections)
Last updated
POST
/v1/collections- Auth
- Bearer API key
- Billing
- free (0 credits).
Creates a new face collection owned by your account. Free (0 credits).
Example request
curl -X POST "https://api.sightradar.com/v1/collections" \
-H "Authorization: Bearer $SR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"collection_id":"event-2026"}'Request body (application/json)
| Field | Type | Description |
|---|---|---|
collection_id required | string | Your chosen identifier for the collection. |
Response body
| Field | Type | Description |
|---|---|---|
collection_id | string | |
status | "active" | "deletion_pending" | "deleting" | "deleted" | |
counts_source | string | Where the counts came from: postgres = the gateway's count registry (the normal case), engine = a live read from the engine (a collection whose registry counts are not ready yet, or ?verify=true). |
photo_count | integer | |
face_count | integer | |
selfie_count | integer | |
created_at | string | |
purge_after | string | Present on deletion_pending collections: when the soft delete becomes permanent. |
Status codes
| Status | Meaning |
|---|---|
200 | Collection created. |
400 | collection_id missing. |
401 | Missing or invalid API key. |
409 | Collection already exists in a non-active state. |