Node / TypeScript SDK

npm install sightradar

import { SightRadar } from "sightradar";

const sr = new SightRadar({ apiKey: "frs_..." }); // or new SightRadar() with SIGHTRADAR_API_KEY

// 1. Create a collection to hold faces.
await sr.createCollection("event-2026");

// 2. Index faces from photos (URL, connected-storage key, or an uploaded file).
await sr.index("event-2026", { url: "https://example.com/group.jpg" });
await sr.index("event-2026", { file: buffer, filename: "photo.jpg", photoId: "img-42" });

// 3. Search the collection with one selfie.
const result = await sr.search("event-2026", { url: "https://example.com/selfie.jpg" });
for (const m of result.matches) console.log(m.photo_id, m.score);

// Detect and quality-gate faces in an image. Nothing is stored.
const det = await sr.detect({ url: "https://example.com/photo.jpg" });
console.log(det.detected_face_count, det.gated_face_count);

// 1:1 verification between two faces.
const cmp = await sr.compare({
  sourceUrl: "https://example.com/a.jpg",
  targetUrl: "https://example.com/b.jpg",
});
console.log(cmp.match, cmp.similarity);

const reg = await sr.registerSelfie("event-2026", { userId: "u_42", url: "https://example.com/selfie.jpg" }); // userId is required
const hits = await sr.searchById("event-2026", reg.point_id!, { limit: 50 });

const receipt = await sr.deleteCollection("event-2026");          // soft: receipt.restorable === true
await sr.restoreCollection("event-2026");
await sr.deleteCollection("event-2026", { compliance: true });   // audited erasure, not restorable
const st = await sr.deletionStatus("event-2026");                // st.phase === "completed" && st.verified_zero
await sr.deletePhoto("event-2026", "img-42");                    // one photo's faces; restorePhoto undoes a soft delete

const wh = await sr.registerWebhook({ url: "https://your.app/webhooks/sightradar" }); // wh.secret is returned once
const batch = await sr.submitBatch({
  collectionId: "event-2026",
  op: "index",
  photos: [{ url: "https://example.com/1.jpg", external_id: "img-1" }],
  webhookEndpointId: wh.webhook_endpoint_id,
});
const status = await sr.getBatch(batch.batch_id);         // succeeded / failed / pending counts
const page = await sr.getBatchPhotos(batch.batch_id);     // per-photo results, keyset paginated

import { verifyWebhookSignature } from "sightradar";
const ok = verifyWebhookSignature({
  secret: storedSecret,
  timestamp: req.headers["x-sightradar-timestamp"],
  signature: req.headers["x-sightradar-signature"],
  body: rawBody,
});

console.log((await sr.wallet()).balance_credits);
console.log(await sr.usage(30));

import { NotFoundError, AuthenticationError } from "sightradar";

try {
  await sr.describeCollection("missing");
} catch (e) {
  if (e instanceof NotFoundError) console.log(e.statusCode, e.message);
}