API · v1.0.0

The public endpoints

Everything below is generated from the OpenAPI document itself. Anything behind the staff login is deliberately absent from both.

Every documented endpoint, its method and path, and the responses it can return.
Method Path What it does Responses
GET / Landing 200, 422
GET /api/scan/{token} Scan Status 200, 422
POST /api/view/{token} Record Dwell 200, 422
GET /checks Checks Page 200
GET /editorial-policy Editorial Policy Page 200
GET /embed.js Embed Script 200
GET /healthz Healthz 200
GET /license License Page 200
GET /llms.txt Llms Txt 200
GET /methodology Methodology Page 200
GET /methodology.md Methodology Markdown 200
GET /privacy Privacy Page 200
GET /robots.txt Robots 200
GET /s/{token} Result Page 200, 422
GET /scan Scan Via Get 200, 422
POST /scan Scan Via Post 200, 422
GET /sitemap-pages.xml Sitemap Pages 200
GET /sitemap.xml Sitemap 200
GET /terms Terms Page 200

The specification is served at /openapi/v1.json, and aliased at /openapi.json and /.well-known/openapi.json. Version 1.0.0 — the contract's version, not the application's.