ReferenceAPI ReferenceOverview

API Reference

This section is auto-generated from the @agorio/sdk source with typedoc. The pages here document every exported symbol — classes like ShoppingAgent, UcpClient, AcpClient, McpClient, and Ap2Client; the LLM adapters; the HTTP and session primitives; and all the public TypeScript types.

If you’re viewing the live docs, the generated pages appear alongside this overview in the sidebar. If you’ve just cloned the repository and don’t see them, generate them locally:

cd docs
npm install
npm run build:api

That runs scripts/build-api-reference.ts, which invokes typedoc against src/index.ts and writes the Markdown into this directory. The generation step is resilient: if typedoc can’t run (for example in an offline environment), it prints a warning and exits cleanly so the rest of the docs still build, leaving this overview in place.

For prose-level explanations of how the pieces fit together, start from the Agents, Protocols, and Plugins sections.