API Reference

Complete API reference for the Orbiter framework.

Packages

orbiter-core

The foundational package providing agents, tools, runners, swarms, hooks, events, configuration, and the type system. Everything you need to build and run LLM-powered agents.

Public modules:

Module	Description
types	Message types, agent I/O, run results, streaming events, base error
config	Configuration dataclasses: ModelConfig, AgentConfig, TaskConfig, RunConfig
registry	Generic named registry with duplicate detection
events	Async event bus for decoupled communication
hooks	Lifecycle hook system for agent execution interception
tool	Tool ABC, FunctionTool, @tool decorator, schema generation
agent	Agent class — the core autonomous LLM-powered unit
runner	run(), run.sync(), run.stream() — the primary execution API
swarm	Multi-agent orchestration with flow DSL
human	Human-in-the-loop tool and input handlers
loader	YAML agent and swarm loader with variable substitution
skills	Multi-source skill registry for loading skills from local paths and GitHub

orbiter-core Internal

Internal modules that power the public API. These are implementation details subject to change without notice.

Module	Description
message_builder	Build ordered message lists for LLM provider calls
output_parser	Parse LLM responses into agent-level output types
state	Run state tracking with execution nodes and lifecycle
call_runner	Core execution loop with loop detection
handlers	Handler abstractions for composable agent execution
agent_group	ParallelGroup and SerialGroup execution primitives
nested	SwarmNode for nesting swarms within swarms
graph	Directed graph, topological sort, flow DSL parser
background	Background task handler with hot-merge and wake-up-merge