API Contracts (Index)
Canonical API, persistence, and integration contracts for ConversionIQ.
Purpose
Section titled “Purpose”This section exists so the product can be rebuilt without reverse-engineering route handlers or client contexts from code.
Use docs/api/** for:
- HTTP endpoints and payload contracts
- auth requirements and permission boundaries
- persistence mutation shapes
- integration adapter contracts
- external service dependencies and expected behaviors
Canonical contract rules
Section titled “Canonical contract rules”- Route docs may summarize API usage, but the canonical request/response contract lives here.
- Domain docs define business rules; API docs define transport and mutation contracts.
- If an endpoint changes, update the matching file in
docs/api/**in the same change.
Planned contract areas
Section titled “Planned contract areas”user-data.md— persisted user blob, profile payloads, mutation typessetup-status.md— onboarding status, connection state, mutation contractlive-agents.md— external live-agents API contract and normalization rulesdashboard-analytics.md— future dashboard aggregate for readiness, customer signals, system metrics, outcomes, and recommended actionsauth.md— sign-in, session, and guard behavior when those contracts are formalized