flow() API Flow builder, workflow graph, and mermaid APIs. rust api api/flow packages/rust/axir-api.json api flow() API

flow() API

Flow builder, workflow graph, execution plan, and mermaid APIs.

Most Used

flow

Create an AxFlow program graph or compile the portable Mermaid shorthand.

FieldValue
Kindfunction
Ax conceptflow
API sectionFlow
Formflow(source) / flow_with_bindings(source, bindings)
ReturnsAxFlow

Important Options

  • nodes
  • execute mappers
  • conditions
  • cache
  • returns
  • Mermaid roundtrip

Examples

Rust
let wf = flow("workflow");

Full reference

AxFlow

Workflow graph with Core-owned planning, cache keys, state merge, child aggregation, optimization, and returns projection.

FieldValue
Kindtype
Ax conceptAxFlow
API sectionFlow
FormAxFlow
Returnsflow program

Important Options

  • steps
  • state
  • parallel groups
  • returns

Full reference

Advanced / internals / full reference

AxExecutableProgram::owned_worker_factory

Optional factory for independent program state. Parallel groups require both client and program factories; otherwise the whole group runs serially with a fallback trace.

FieldValue
Kindmethod
Ax conceptowned_program_factory
API sectionFlow
FormAxExecutableProgram::owned_worker_factory()
Returnsworker factory or unavailable

Important Options

  • owned memory
  • per-node controls
  • deterministic result merge
  • cooperative cancellation

Full reference

Full Reference

Open the full Rust reference. This page highlights the flow symbols most relevant to everyday use.

Docs