API Reference

Auto-generated documentation from source code docstrings, grouped by subsystem.

Core

Core API

Configuration, service, task, model, worker, plugin, and exception APIs.

Core API
Reference Map

A quick index for the grouped API reference pages.

Reference Map

Backends

Queue Backends

Queue backend registry, base protocol, memory, SQLSpec, Advanced Alchemy, Redis, and Valkey modules.

Queue Backends
Execution Backends

Execution backend registry, immediate execution, local workers, and Cloud Run execution modules.

Execution Backends

Realtime

Events

Queue event envelopes, publishers, context helpers, sinks, channel names, and Litestar Channels integration.

Events