# Find a public contract

> Start with a working guide. Use the emitted TypeScript reference when you need an option, method or return type.

- Package: `@db3.ai/app`
- Canonical page: [https://db3.ai/docs/api-reference](https://db3.ai/docs/api-reference)
- Markdown: [https://db3.ai/docs/api-reference.md](https://db3.ai/docs/api-reference.md)
- Framework source of truth: `packages/app/README.md`

<a id="use"></a>

## Guide first, signature when needed

Each service below links to its task-oriented guide and a focused declaration reference. The references are generated from the same compiled package shape consumers install, not manually transcribed interfaces.

A public import path is supported by the package export map. Relative imports inside a declaration describe its type dependencies; they do not grant arbitrary deep imports into private implementation files.

- [Install or create an app](https://db3.ai/docs/installation.md)
- [Solve a concrete problem](https://db3.ai/docs/solve-a-problem.md)

<a id="app"></a>

## App

- [App guide and examples](https://db3.ai/docs/app.md)
- [App signatures and options](https://db3.ai/docs/app-api.md)

<a id="config"></a>

## Config

- [Config guide and examples](https://db3.ai/docs/config.md)
- [Config signatures and options](https://db3.ai/docs/config-api.md)

<a id="auth"></a>

## Auth

- [Auth guide and examples](https://db3.ai/docs/auth.md)
- [Auth signatures and options](https://db3.ai/docs/auth-api.md)

<a id="active-record"></a>

## ActiveRecord

- [ActiveRecord guide and examples](https://db3.ai/docs/active-record.md)
- [ActiveRecord signatures and options](https://db3.ai/docs/active-record-api.md)

<a id="fields"></a>

## Fields

- [Fields guide and examples](https://db3.ai/docs/fields.md)
- [Fields signatures and options](https://db3.ai/docs/fields-api.md)

<a id="migrations"></a>

## Migrations

- [Migrations guide and examples](https://db3.ai/docs/migrations.md)
- [Migrations signatures and options](https://db3.ai/docs/migrations-api.md)

<a id="validation"></a>

## Validation

- [Validation guide and examples](https://db3.ai/docs/validation.md)
- [Validation signatures and options](https://db3.ai/docs/validation-api.md)

<a id="cache"></a>

## Cache

- [Cache guide and examples](https://db3.ai/docs/cache.md)
- [Cache signatures and options](https://db3.ai/docs/cache-api.md)

<a id="events"></a>

## Events

- [Events guide and examples](https://db3.ai/docs/events.md)
- [Events signatures and options](https://db3.ai/docs/events-api.md)

<a id="logging"></a>

## Logging

- [Logging guide and examples](https://db3.ai/docs/logging.md)
- [Logging signatures and options](https://db3.ai/docs/logging-api.md)

<a id="security"></a>

## Security

- [Security guide and examples](https://db3.ai/docs/security.md)
- [Security signatures and options](https://db3.ai/docs/security-api.md)

<a id="mail"></a>

## Mail

- [Mail guide and examples](https://db3.ai/docs/mail.md)
- [Mail signatures and options](https://db3.ai/docs/mail-api.md)

<a id="storage"></a>

## Storage

- [Storage guide and examples](https://db3.ai/docs/storage.md)
- [Storage signatures and options](https://db3.ai/docs/storage-api.md)

<a id="media"></a>

## Media

- [Media guide and examples](https://db3.ai/docs/media.md)
- [Media signatures and options](https://db3.ai/docs/media-api.md)

<a id="queue-overview"></a>

## Queue

- [Queue guide and examples](https://db3.ai/docs/queue-overview.md)
- [Queue signatures and options](https://db3.ai/docs/queue-api.md)

<a id="scheduler"></a>

## Scheduler

- [Scheduler guide and examples](https://db3.ai/docs/scheduler.md)
- [Scheduler signatures and options](https://db3.ai/docs/scheduler-api.md)

<a id="flows"></a>

## Flows

- [Flows guide and examples](https://db3.ai/docs/flows.md)
- [Flows signatures and options](https://db3.ai/docs/flows-api.md)

<a id="serialization"></a>

## Serialization

- [Serialization guide and examples](https://db3.ai/docs/serialization.md)
- [Serialization signatures and options](https://db3.ai/docs/serialization-api.md)

<a id="url"></a>

## URLs

- [URLs guide and examples](https://db3.ai/docs/url.md)
- [URLs signatures and options](https://db3.ai/docs/url-api.md)

<a id="ssr"></a>

## SSR

- [SSR guide and examples](https://db3.ai/docs/ssr.md)
- [SSR signatures and options](https://db3.ai/docs/ssr-api.md)

<a id="ai"></a>

## AI text

- [AI text guide and examples](https://db3.ai/docs/ai.md)
- [AI text signatures and options](https://db3.ai/docs/ai-api.md)

<a id="packages"></a>

## Package inventories

The package pages list the supported import entry points. Pure includes its complete emitted utility declarations. The source-backed Markdown pages expose the same content to AI tools, with linked examples and behavior tests.

- [@db3.ai/app package](https://db3.ai/docs/package-app.md)
- [@db3.ai/pure package](https://db3.ai/docs/package-pure.md)

<a id="coverage"></a>

## What reference coverage means

Declarations show the current typed API, not proof that every provider/deployment combination was tested. Each guide separates its executed happy/failure path from explained features and TODO recipes. Pin your package version and keep docs, examples and runtime in the same release.

## Related documentation
- [@db3.ai/app](https://db3.ai/docs/package-app.md): The backend runtime: application services, field-aware records, durable work and optional web delivery.
- [@db3.ai/pure](https://db3.ai/docs/package-pure.md): Small portable helpers for ordinary application data. They do not create an App or replace validation and authorization.
- [Test the feature a developer will use](https://db3.ai/docs/testing.md): Run real framework components through their public boundary. Make failure, recovery and cleanup part of the test.

## Guidance for AI tools
Use the documented public import `@db3.ai/app` and its exported types. Prefer the source-backed examples and behavioural outcomes above over invented APIs or source-relative internal imports.