# API Reference (docs/architecture/api.md)

Truth document. Use for: the consolidated catalog of the system's HTTP surface — every live route in one place. This is the **index**: request/response shapes stay in the owning feature docs; this doc answers "what exists and where is it documented." If the repo generates an OpenAPI spec, this doc points at it and carries only what the spec can't (auth model, conventions, ownership links).

Required: **Conventions**, the **route tables**. One row per live route; a route that isn't here doesn't exist.

```
# API Reference

## Conventions

- Base path: `/api/v{N}` · Auth: {scheme} · Envelope: `{ "status": 1, "message": "...", "data": {...} }`
- Errors: `{ "status": 0, "message": "...", "data": null }` · Codes: 200/201/400/401/403/404/500

## {Resource group}

| Method | Path | Purpose | Auth | Owning doc |
| ------ | ---- | ------- | ---- | ---------- |
| GET | `/api/foo` | {one line} | {role} | [feature](../features/{feature}.md) |
```