Skip to main content

State machine orchestration for agent workflows.

Project description

FlatMachines (Python SDK)

State-machine orchestration for LLM agents. FlatMachines is agent-framework agnostic and uses adapters to execute agents from FlatAgents, smolagents, pi-mono, or other runtimes.

For LLM/machine readers: see AGENTS.md.

Install

pip install flatmachines[flatagents]

Optional extras:

  • flatmachines[cel] – CEL expression engine
  • flatmachines[validation] – JSON schema validation
  • flatmachines[metrics] – OpenTelemetry metrics
  • flatmachines[smolagents] – smolagents adapter

Quick Start

from flatmachines import FlatMachine

machine = FlatMachine(config_file="workflow.yml")
result = await machine.execute(input={"query": "..."})
print(result)

workflow.yml

spec: flatmachine
spec_version: "0.10.0"

data:
  name: reviewer
  agents:
    reviewer: ./reviewer.yml
  states:
    start:
      type: initial
      agent: reviewer
      input:
        code: "{{ input.code }}"
      output_to_context:
        review: "{{ output }}"
      transitions:
        - to: done
    done:
      type: final
      output:
        review: "{{ context.review }}"

Agent Adapters

FlatMachines delegates agent execution to adapters. Built-ins are registered automatically if their dependencies are installed:

  • flatagent – uses FlatAgents configs (flatmachines[flatagents])
  • smolagents – executes MultiStepAgent via agent_ref.ref factories
  • pi-agent – Node bridge to pi-mono using pi_agent_runner.mjs

Agent refs in data.agents can be:

  • string path to a flatagent config
  • inline flatagent config (spec: flatagent)
  • typed adapter ref: { type: "smolagents" | "pi-agent" | "flatagent", ref?: "...", config?: {...} }

Custom adapters can be registered via AgentAdapterRegistry.

State Execution Order

For each state, the Python runtime executes in this order:

  1. actionhooks.on_action
  2. launch → fire-and-forget machine(s)
  3. machine / foreach → peer machines (blocking)
  4. agent → adapter + execution strategy
  5. output → render final output for type: final

Jinja2 templates render input, context, and output. A plain string like context.foo resolves to the actual value (not a string).

Execution Types

execution:
  type: retry
  backoffs: [2, 8, 16]
  jitter: 0.1

Supported: default, retry, parallel, mdap_voting.

Parallelism & Launching

  • machine: child → invoke peer machine (blocking)
  • machine: [a, b] → parallel
  • foreach: "{{ context.items }}" → dynamic parallelism
  • launch: child → fire-and-forget; result is written to backend

Persistence & Resume

persistence:
  enabled: true
  backend: local  # local | memory | sqlite
  checkpoint_on: [machine_start, state_enter, execute, state_exit, machine_end]

SQLite backend (recommended for durable single-file persistence)

persistence:
  enabled: true
  backend: sqlite
  db_path: ./flatmachines.sqlite   # optional, defaults to flatmachines.sqlite

When backend: sqlite is declared, the SDK automatically selects:

  • SQLiteCheckpointBackend for checkpoint storage
  • SQLiteLeaseLock for concurrency control
  • SQLiteConfigStore for content-addressed config storage (auto-wired when no explicit config_store is passed)

No imperative runner injection required — everything is driven from config.

db_path resolution order: config field → FLATMACHINES_DB_PATH env var → flatmachines.sqlite.

Resume with machine.execute(resume_from=execution_id). Checkpoints store MachineSnapshot including pending launches.

Hooks

Configure hooks via data.hooks:

hooks:
  file: ./hooks.py
  class: MyHooks
  args: { ... }

Built-ins: LoggingHooks, MetricsHooks, WebhookHooks, CompositeHooks.

Invokers & Result Backends

Invokers define how peer machines are launched:

  • InlineInvoker (default)
  • QueueInvoker (base class for external queues)
  • SubprocessInvoker (python -m flatmachines.run)

Results are written/read via ResultBackend URIs: flatagents://{execution_id}/result.

Logging & Metrics

from flatmachines import setup_logging, get_logger
setup_logging(level="INFO")
logger = get_logger(__name__)

Env vars match FlatAgents: FLATAGENTS_LOG_LEVEL, FLATAGENTS_LOG_FORMAT, FLATAGENTS_LOG_DIR.

Metrics require flatmachines[metrics] and FLATAGENTS_METRICS_ENABLED=true.

CLI Runner

python -m flatmachines.run --config machine.yml --input '{"key": "value"}'

Examples (Repo)

Specs

Source of truth:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flatmachines-3.0.0.tar.gz (133.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flatmachines-3.0.0-py3-none-any.whl (159.5 kB view details)

Uploaded Python 3

File details

Details for the file flatmachines-3.0.0.tar.gz.

File metadata

  • Download URL: flatmachines-3.0.0.tar.gz
  • Upload date:
  • Size: 133.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for flatmachines-3.0.0.tar.gz
Algorithm Hash digest
SHA256 313787a55ff0b85a593863db8a6d91614a38e28b60735501171579076cdca736
MD5 43830d9b15b35a63ac67a66eeabdab7f
BLAKE2b-256 908654b8a9443472cdf0ef6e457a580f2cb660a44cfbb8c199cb289f40671dc1

See more details on using hashes here.

File details

Details for the file flatmachines-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: flatmachines-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 159.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for flatmachines-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d99843d6d61f2dc9cc4960009ae957d024b507ba7500dc01a71f816fa3243454
MD5 f12a84189e424b93d8215cf2f54f0d8a
BLAKE2b-256 c763f5ed35bd73b0ef5d3d18636f6b66e7d1e47872208d66909eed7909c4b932

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page