API Overview

The brin REST API — no auth, no signup, one GET request

The brin API scores any external context your agent might interact with. No auth, no signup, no SDK required.

##Base URL

https://api.brin.sh

##Entity types

brin supports 9 origin types across 6 context categories:

##Quick example

curl https://api.brin.sh/npm/express

{
  "score": 85,
  "verdict": "safe",
  "confidence": "high",
  "tolerance": "conservative",
  "url": "https://api.brin.sh/npm/express",
  "scanned_at": "2026-03-01T12:00:00Z"
}

Every response also includes headers for lightweight checks:

x-brin-score:      85
x-brin-verdict:    safe
x-brin-confidence: high
x-brin-tolerance:  conservative

##Verdicts

##New artifacts

If an artifact hasn't been scanned yet, brin returns a preliminary score immediately and queues a full 3-tier scan in the background. Subsequent requests return the full result. Use a webhook to get notified when the scan completes:

curl "https://api.brin.sh/npm/some-package?webhook=https://your-server.com/callback"

##Safety tolerance

Tolerance controls how the numeric score (0–100) maps to a verdict. The raw score never changes.

curl "https://api.brin.sh/npm/express?tolerance=lenient"

##Authentication

No authentication required. The API is public and free.

##Rate limits

300 requests per minute per IP. Contact us for higher limits.