Scheduler API

Scheduler API

Lifecycle

async with Scheduler() as scheduler:
    ...

or:

scheduler = Scheduler()
await scheduler.start()
...
await scheduler.stop()

Core methods

enqueue_input(...)

Queue the next input for a persistent root that is IDLE or FAILED.

route_root_input(...)

Canonical integration entry point used by Console and channels. It decides whether the correct action is:

• submitted
• enqueued
• steered

The returned RouteResult.stream is the root stream for that routed turn.

wait_for(...)

Wait until a state settles to IDLE, COMPLETED, or FAILED.

Control methods

• steer(...)
• cancel(...)
• shutdown(...)
• rebind_agent(...)

Query methods

• get_state(...)
• list_states(...)
• list_events(...)
• get_stats(...)
• get_registered_agent(...)

Stream semantics

• route_root_input() exposes stream consumption through RouteResult.stream
• only one live stream subscriber is allowed per root state_id
• RouteResult.stream is None only for steered + RUNNING, where the existing subscriber keeps consuming the live stream

State storage backends

SchedulerConfig.state_storage.storage_type supports:

• memory
• sqlite
• mongodb

Route stream modes

RouteStreamMode currently supports:

• RUN_END
• UNTIL_SETTLED