When the API ships, this page will document:
POST /api/assess: enqueue an assessment job. Request body includes the subject identifier and optional flags (deep analysis, AI provider, pillars filter). Returns ajobId.GET /api/assess/[jobId]/stream: server-sent events for live progress.GET /api/report/[id]: fetch a completed report as JSON matching the report schema.GET /api/report/[id]/pdf: render the Executive view as PDF.GET /api/badge/[owner]/[repo].svg: SVG badge for the most recent report.
Authentication uses BetterAuth session cookies (GitHub or Google OAuth) for interactive flows and scoped personal access tokens for machine-to-machine use. Rate limits and quotas apply per account; specific numbers will be published with the initial API release.
Related
- CLI: current programmatic interface.
- Tools: API, high-level overview of what the API enables.