# Reference

Lookup material, generated from the code wherever possible. To learn by doing, start with the [tutorial](<https://sandloom.dev/docs/getting-started/tutorial/index.md>); to understand why, start with [What a module is](<https://sandloom.dev/docs/modules/index.md>).

| Reference | Contents |
| --- | --- |
| [Python API (`sandloom.sdk`)](<https://sandloom.dev/docs/reference/sdk/index.md>) | every public module and name with its exact signature, beginner names first (generated) |
| [Driver kit (`sandloom.driverkit`)](<https://sandloom.dev/docs/infrastructure/driverkit/index.md>) | the API for driver packages; modules never import it |
| [Error catalogue](<https://sandloom.dev/docs/reference/error-codes/index.md>) | every `SANDLOOM-*` code: what happened, the fix, its status (generated; also `sandloom explain <code>`) |
| [Testing](<https://sandloom.dev/docs/reference/testing/index.md>) | the `sandloom.sdk.testing` kit, the fixtures and the harness rules (copy-paste) |
| [CLI](<https://sandloom.dev/docs/reference/cli/index.md>) | every `sandloom` command |
| [Operator reference](<https://sandloom.dev/docs/operate/operator-reference/index.md>) | incident tools, flags, dry runs and production confirmation |
| [Configuration](<https://sandloom.dev/docs/reference/configuration/index.md>) | every environment variable, generated from the settings model |
| [Configuration tiers](<https://sandloom.dev/docs/reference/configuration-tiers/index.md>) | which settings change a guarantee, per profile (generated) |
| [Routes](<https://sandloom.dev/docs/reference/routes/index.md>) | every platform route and its resolved policy (generated) |
| [Event contracts](<https://sandloom.dev/docs/reference/event-contracts/index.md>) | channel naming, the schema registry, validation, evolution |
| [Security model](<https://sandloom.dev/docs/reference/security-model/index.md>) | authentication, tenant isolation, idempotency, audit, secrets, the production profile |
| [Guarantees &amp; capabilities](<https://sandloom.dev/docs/reference/guarantees/index.md>) | the ledger: every guarantee with the tests that enforce it, and the recorded gaps (generated) |
| [Execution planner](<https://sandloom.dev/docs/reference/execution-planner/index.md>) | declared read operations and the planner |
| [SLOs](<https://sandloom.dev/docs/reference/slo/index.md>) | SLIs from the shipped metrics, example SLOs and an error-budget template |
| [Dependency stack](<https://sandloom.dev/docs/reference/dependencies/index.md>) | the libraries Sandloom builds on |
| [Standard modules](<https://sandloom.dev/docs/modules/standard/index.md>) | identity, tenancy and billing: routes, events, contracts |

Regenerate the committed generated pages (`sdk/` and the error catalogue) with `uv run python tools/docs/docs_reference.py`; the docs build fails while they are stale.