SightRadardocs
API reference

API reference

Every endpoint of the SightRadar Face Recognition API, generated from the OpenAPI 1.0.0 specification.

Base URL https://api.sightradar.com. Every /v1/* endpoint authenticates with Authorization: Bearer frs_<prefix>_<secret>; see Authentication to get a key. The machine-readable spec is at /openapi.json, and the playground lets you call any endpoint with your own key.

Collections

Create and manage face collections (the registry of your indexed photos).

Faces

Index, search, detect, and compare faces (billable operations).

Selfies

Register a single-face selfie for later search-by-id.

Batch

Asynchronous bulk processing with webhook callbacks.

Webhooks

Register endpoints for per-photo batch results and verified deletion completion events.

Wallet & Usage

Check your credit balance, usage, and auto-recharge config.

Health

Liveness and readiness probes (unauthenticated).

All endpoints

MethodPathOperation
GET/v1/collectionsList collections
POST/v1/collectionsCreate a collection
GET/v1/collections/{id}Describe a collection
DELETE/v1/collections/{id}Delete a collection (soft by default, restorable)
POST/v1/collections/{id}/restoreUndo a soft collection delete
POST/v1/collections/{id}/photos/{photoId}/restoreUndo a soft photo delete
GET/v1/collections/{id}/deletionGet collection deletion status
GET/v1/collections/{id}/metricsCollection metrics
DELETE/v1/collections/{id}/photos/{photoId}Delete one photo's faceprints (soft by default, restorable)
POST/v1/collections/{id}/indexIndex faces from a photo
POST/v1/collections/{id}/searchSearch a collection
POST/v1/collections/{id}/search-by-idSearch by a stored selfie point id
POST/v1/detectDetect faces (no storage)
POST/v1/compareCompare two faces
POST/v1/collections/{id}/selfiesRegister a selfie
GET/v1/batchesList batches
POST/v1/batchesSubmit a batch job
POST/v1/batches/failed/requeuePreview or execute a failed-photo retry wave
POST/v1/batches/statusesGet statuses for an explicit batch set
GET/v1/batches/{id}Get batch status
GET/v1/batches/{id}/photosGet per-photo batch results
GET/v1/webhooksList webhook endpoints
POST/v1/webhooksRegister a webhook endpoint
DELETE/v1/webhooks/{id}Disable a webhook endpoint
GET/v1/webhooks/dead-lettersList dead-lettered webhook deliveries
POST/v1/webhooks/dead-letters/replayReplay dead-lettered webhook deliveries
GET/v1/walletGet credit balance
GET/v1/usageUsage report
GET/v1/usage/dailyDaily usage time series
GET/healthLiveness probe (alias of /healthz)
GET/healthzLiveness probe
GET/readyzReadiness probe
Last updated
MarkdownAgents

Rekognition shim (Python)

A drop-in client that lets boto3 Rekognition code run against SightRadar with a two-line change, translating method names, arguments, scores and response shapes.

Collections

Create and manage face collections (the registry of your indexed photos).

On this page

All endpoints