Runtime SDK
Define swarms, run turns, manage sessions, execute tools, and inspect runtime events with `swarmforge.swarm`.
Author, build, run, and evaluate multi-agent systems with one Python SDK for graph authoring, runtime orchestration, FastAPI transport, and evaluation.
SwarmForge v5 breaking changes
SwarmForge v5 removes implicit handoff routes. Specialists must declare return and cross-specialist edges explicitly. See Migrating to v5 before upgrading from v4.
These docs explain how to install, configure, and use swarmforge as a package. They do not describe the maintainer workflow for developing SwarmForge itself; use CONTRIBUTING.md for repository development and release steps.
These docs are for application developers who want to build agents, swarms, FastAPI endpoints, or evaluation flows with SwarmForge. They assume that you are comfortable with Python and can set environment variables for a hosted model provider.
Before you run provider-backed examples, set MODEL_PROVIDER, LLM_MODEL, and the matching API key described in Providers.
After reading this docs set, you should be able to:
Current package version: 5.0.0.
SwarmSession, process_swarm_stream(...), event flow, tool execution, and persistence hooks.ModelConfig, environment variables, wrapper behavior, and request customization.create_fastapi_app(...), endpoints, SSE behavior, and storage injection.