Reference overview
Complete Python API reference for all public classes and methods.
Complete Python API reference for all public classes and methods.
| Class | Description |
|---|---|
| Queue | Central orchestrator — task registration, enqueue, workers, and all queue operations |
| TaskWrapper | Handle returned by @queue.task() — delay(), apply_async(), map(), signatures |
| Worker | run_worker() — pools, tags, shutdown, worker introspection |
| JobResult | Handle for an enqueued job — status polling, result retrieval, dependencies |
| JobContext | Runtime context inside a running task — job ID, retry count, progress updates |
| Canvas | Workflow primitives — Signature, chain, group, chord |
| Workflows | DAG workflow builder, WorkflowRun, gates, sub-workflows |
| Testing | Test mode, TestResult, MockResource for unit testing tasks |
| CLI | flexiq command-line interface — worker, dashboard, info, pause, resume, scaler, autoscale, resources, reload |