API reference

These guides document behavior — how a turn runs, what a capability flag changes, what happens when something fails. Symbol-level documentation — every parameter, every return value, every throws clause — lives in the DocC catalog that ships inside the package.

One product, one import:

import AgentKit

The AgentKit product re-exports everything: the core (sessions, tool domains, guards, undo, context sources, structured output), the cloud providers (Anthropic, OpenAI, Gemini, and the backend router), and — when built with an SDK that ships the FoundationModels framework — the on-device Apple provider. You never import a submodule.

To read the reference, Option-click any AgentKit symbol in Xcode: Quick Help renders the doc comments inline, and Build Documentation produces the browsable catalog. Swift Package Index renders the same catalog on the web. Public symbols carry usage-level documentation — what to pass, what comes back, what fails — not restated signatures.

The two layers divide cleanly: behavioral claims live in these guides, one page per topic, with every example compiled and tested against the SDK; the API reference describes each symbol in isolation. Start from your first agent for the end-to-end path, or the capability matrix when you need a single fact fast.