← Methodology and API

API versioning and lifecycle

Stable machine clients should use the /api/v1 report and health routes. Legacy unversioned routes remain compatibility surfaces while they are documented.

Compatibility signals

Clients should inspect Content-Type, Vary: Accept, and the structured ok/data or ok/error envelope. Rate-limited requests return Retry-After and RateLimit-* headers.

When a future route is deprecated, AnswerReady will publish Deprecation, Sunset, and a documentation Link header. Clients should prefer the linked replacement before the sunset date.

Report representations

GET /api/v1/scans/{id} returns JSON by default and negotiated Markdown for Accept: text/markdown. Unknown IDs remain structured 404 responses; they are not converted to a successful application shell.