Getting Started Guides Architecture API Changelog

Choose SDK

TaskWrapper Worker JobResult Job Context Serializers Canvas Workflows Saga Batching Testing Errors CLI Reference

Python/

API Reference

Every public class, method, and CLI command in flexiq.

← PreviousSerialization Next →Overview

Reference docs for everything flexiq exposes. Each page lists the full signature, parameters, return values, and a short example.

OverviewThe shape of the public API — what's stable, what's experimental.QueueConstruct queues, enqueue jobs, manage workers, inspect state.TaskThe @queue.task decorator — options, methods, async variants.ResultJobResult, polling, awaiting, timeouts, sync and async APIs.Contextcurrent_job — progress, logging, cancellation, timeouts inside a task.SerializersSmartSerializer, JSON/CBOR, payload codecs, signing and encryption.Canvaschain, group, chord — the Celery-compatible composition primitives.WorkflowsThe DAG builder — fan-out, fan-in, gates, conditions, sub-workflows.SagaCompensating workflows — rollback steps that undo completed work on failure.BatchingCoalesce many enqueues into a single batched job.Testingtest_mode, MockResource, fixtures for synchronous in-process verification.ErrorsThe FlexiQError exception hierarchy — catch by type or by the base.CLIflexiq worker, dashboard, info, pause, resume, scaler, autoscale, resources, reload.