This dashboard is for buyers and operators (CFO/CTO). Create your organisation, issue an API key for your app, add credits, and view reports.
How Sparse Guard works: your app asks for approval before an AI call (to prevent runaway spend), then reports back after the call (for accurate billing + audit).
Start
Setup: Sign in → Create organisation → Create API key → Add credits
Operate: Your app uses the API key to get approvals and record usage
Report: Download credits and emissions reports for finance/audit
System status
Confirms the service is online and responding.
Session
Stored in your browser to keep you signed in. "Sign out" clears it.
Get running in 3 steps
1.
Create your organisation in "Organisation".
2.
Create an API key in "API key". This is what your app uses.
3.
Add credits in "Add credits", then view Reports for audit.
Buyer translation: credits = pre-funded AI budget. reports = proof for finance, procurement, and audit.
Sign in
Create an account or sign in to manage your organisation, billing, and reporting.
Register
Login
Tenant
Create a tenant (org) using your JWT.
Create tenant
Your API currently supports GBP. Add USD/EUR later in backend + pricing.
Current tenant
API key
Create an API key for your app. This is the credential your workloads use to request approvals and record usage.
Mint key
Current API key
Treat API keys like money + governance power.
Add credits
Credits are your AI budget. Add credits via Stripe, then Guard enforces usage against that budget.
Create PaymentIntent
You'll receive a clientSecret. Confirm payment via Stripe UI in your final customer flow.
Admin topup (optional)
Works only if ALLOW_ADMIN_TOPUP=1. Uses ADMIN_TOKEN.
Reports
Finance/audit view. Paste an API key to load credit spend and the emissions report (optional).
Credits ledger
Kind
Amount
Currency
Ref
Created
Emissions report (optional)
ikgCO₂e means "kilograms of CO₂-equivalent".
It's an estimate of greenhouse-gas impact from compute energy.
Sparse Guard records methodology + factor versions for audit traceability.
TS
Model
Tin
Tout
J
kWh
gCO₂e
Cost
Method
Buyer takeaway: emissions drop when Guard prevents unnecessary compute (right-sizing + fewer retries/spikes).
Connect your app
This is the only thing customers need to understand after minting an API key:
Approve → Execute → Record.
Sparse Guard sits in front of your model/tool calls and prevents runaway spend by making a decision before you pay.
1) Approve (POST /v1/govern)
You send a lightweight "plan" for the request. Guard returns ALLOW/DENY, a reservationId, and requiredD (USL right-sizing).
2) Execute (your system)
If allowed, you call your model/tool provider using the limits Guard recommends (tokensOutMax etc).
3) Record (POST /v1/settle)
You send the reservationId plus what actually happened (tokens, optional quality metric φ). Guard finalises credit spend and writes the audit receipt.
API Base URL
Defaults to the current host. Change if calling a different env.
API key: paste your sg_... key (same key used for Reports). Never expose it client-side in production — use server-to-server calls.
Copy/paste curl (server-side)
This is the simplest plumbing: wrap one function around your LLM call.
What the fields mean
alpha = contention / load (0–1). kappa = quality tolerance (0–1). gamma = scaling parameter. d = requested capacity (dimension). phi (φ) = observed quality metric (0–1) you can optionally report back to improve SatConform. tokensOutMax = max output tokens you plan to allow.
TypeScript wrapper
Python wrapper
Production note (important)
The API key should be used from your backend/service layer, not from a browser. The browser console is for setup + visibility, not for embedding secrets into client apps.