SDK index

The Flux Python SDK is the surface you import from flux. The pages in this sub-group are auto-generated from the source by an introspection script, so the signatures, defaults, and docstrings track what is actually in the installed package.

Core decorators

The two decorators that turn plain functions into Flux primitives.

• workflow — marks a function as a workflow. Workflows are the durable, replayable unit of execution.
• task — marks a function as a task. Tasks are the deterministic, retriable, cacheable steps a workflow composes.

Agent surface

The agent SDK ships in 0.56.0 but the introspection generator does not yet emit a standalone agent.mdx page. The agent primitive, its lifecycle, and its configuration are covered in Agents → Foundations → The agent primitive. This SDK index reflects what the generator produces; when the generator picks up the agent module, the entry will appear here.

Building blocks

The composition, control-flow, scheduling, and runtime types tasks and workflows are built from.

• call — invoke a workflow from inside another workflow.
• pause — suspend a workflow until an external signal resumes it.
• Schedule — the base class for schedule definitions.
• cron — cron-expression schedule.
• interval — fixed-interval schedule.
• once — single-fire schedule at a given instant.
• ExecutionContext — the per-execution handle workflows and tasks receive.
• ExecutionState — the enum of execution states.
• ExecutionEvent — the event record written to the event log.
• ExecutionEventType — the enum of event types.
• ScheduleType — the enum of schedule kinds.
• ScheduleStatus — the enum of schedule lifecycle states.
• TaskMetadata — the metadata record attached to each task invocation.

Composition helpers

Free functions exported from flux.tasks for composing tasks.

• parallel — run multiple coroutines concurrently and collect their results.
• pipeline — thread an input through a sequence of tasks, feeding each result into the next.