Documentation

Docs & API reference

Everything to get a dataset scanned or wire the scanner into CI.

Quickstart

CSV format

Upload a CSV with numeric feature columns and a final binary label column (0 or 1). A header row is optional and auto-detected.

feature_1,feature_2,feature_3,label
0.41,1.22,-0.30,1
-0.85,0.03,0.77,0
1.05,-0.42,0.18,1
Concepts

Critical epsilon

The smallest perturbation budget ε at which test accuracy drops below 50% under an FGSM attack. Lower critical epsilon means a more fragile model.

Critical εRating
< 0.15High risk
0.15 – 0.30Medium risk
> 0.30 or not reachedLow risk
API reference

REST endpoints

POST /api/auth/signup

Creates an account. Body: { name, company, email, password }. Returns a bearer token.

POST /api/auth/login

Body: { email, password }. Returns a bearer token valid for 7 days.

POST /api/scans

Requires Authorization: Bearer <token>. Body: a scan summary object (dataset name, clean accuracy, critical epsilon, rating, epsilon/accuracy points). Persists it to your scan history.

GET /api/scans

Requires a bearer token. Returns the authenticated user's saved scan history.

POST /api/contact

Body: { name, email, company, message }. Stores the message and, if SMTP is configured, emails your team.

Full request/response schemas and language SDKs are on the roadmap — tell us what you need.