Chapter 06 / 14

API reference

Contract shape

Sanic owns /api/v1/* and selected public pages. JSON errors have stable status families and correlation IDs. Request bodies are bounded before parsing. Unknown fields are rejected on security-sensitive routes. Streaming responses use bounded NDJSON or WebSocket frames with explicit event types.

Authentication and CORS

Public preparation routes can be anonymous. Account and operator routes require their own bearer-token class and server-side session. Presentation routes accept only the exact configured slides origins and never credentials. Preflight responses list only the method and headers a route needs; wildcard origins are rejected.

Important public surfaces

• Health and readiness distinguish process availability from dependency readiness.
• Questionnaire and results expose deterministic guidance and provenance.
• Form conversation returns questions, field bindings, ownership, and completion state.
• Form PDF returns a transient downloadable document with Cache-Control: no-store.
• Demo capabilities, coverage, and voice-call streams are bounded synthetic surfaces.

Idempotency and failures

Effectful tool and telephony requests use stable request identities. Validation failures are 4xx; disabled capability gates are 503; internal failures are redacted 5xx responses. Provider timeouts and circuit state do not leak vendor payloads. Clients may retry only contracts documented as idempotent.

The generated route inventory shipped with this site is the mechanical reference for methods and paths; service modules remain the authority for semantics.