API reference/ Usage
API reference

Usage

Monthly classifications by stage, quota and remaining checks for a key.

GET /v1/usage API key
Query
month string default current month

Month as YYYY-MM.

curl "https://api.spamex.dev/v1/usage?month=2026-09" -H "Authorization: Bearer $SPAMEX_KEY"
{
  "tenant": "acme-plumbing.com",
  "month": "2026-09",
  "by_stage": { "rules": 312, "ml": 4021, "llm": 187 },
  "total": 4520,
  "quota": 25000,
  "remaining": 20480,
  "feedback_count": 9
}
Fields
by_stage object

Classifications decided by memory, reputation and rules (rules), by the classifier (ml), and by the language model (llm).

total integer

All classifications this month. Fast-mode requests count once; a full-mode re-check counts again.

quota integer

Monthly allowance for the key. 0 means unlimited.

remaining integer | null

quota minus total, never below zero. null when the key has no quota.

feedback_count integer

Verdicts for this key that have received feedback, all time.

account object | null

On a dedicated deployment, the volume shared by every key on it: total, quota and remaining for the month. null on the shared service, where each key has its own allowance.

The stage split tells you what your traffic looks like. llm is the only stage that involves an external call, and the share of gray-zone cases is a useful health signal: a sudden rise usually means a new kind of message, legitimate or not, that the memory has not seen yet.

For usage across all of a platform’s site keys, see Platform usage.

↑↓ navigate↵ openDocs and blog