API Reference

The public surface of the framework's core modules, grouped by theme. Each page lists the exported symbols; their signatures and docstrings are authoritative in the source. Usage walkthroughs live under Guides and the per-topic sections linked from each page.

Core

• Agent — Configuration-only object. Name, instructions, tools, handoffs, guardrails.
• Runner — Execution entry-points: arun, arun_streamed, arun_graph, arun_swarm.
• LLM — Framework-owned LLM abstract base class.
• FunctionTool — The Tool ABC + decorator + types.

Orchestration

• Swarms — Iterative multi-agent collaboration with explicit termination and pluggable routing.
• Graphs — State-machine orchestration with checkpointing, interrupts, and streaming events.
• Flows — Decorator-driven multi-step orchestration over typed shared state.
• Tasks — Declarative units of work composed into pipelines and groups.

State and persistence

• Memory — Extracted, searchable knowledge carried across sessions.
• Session — Conversation persistence for agent runs.

Safety and protocols

• Guardrails — Built-in PII, prompt-injection, and wrong-language guardrails.
• MCP — Model Context Protocol servers, lifecycle, and tool filters.
• A2A — Agent-to-Agent protocol client and server surfaces.

Foundations

• Exceptions — The framework exception hierarchy rooted at AugmentsError.
• Types — Provider-agnostic wire and history types.