API reference

The full TypeScript API reference is auto-generated from src/index.ts on every documentation build by docusaurus-plugin-typedoc, which drives TypeDoc and renders the result as Markdown pages inside this site's sidebar.

Browse the generated reference under the API section of the left sidebar.

How regeneration works

The plugin runs as part of pnpm --dir website build. It reads src/index.ts (the public entrypoint of @agent-assembly/sdk), traverses every exported symbol, and writes Markdown pages under website/docs/api/ (gitignored). Those pages are then included by Docusaurus's autogenerated sidebar so the API reference behaves like any other doc page — navigation, search, and dark mode all work without extra configuration.

You do not need to commit anything under website/docs/api/; the workflow regenerates it on each push to master.

Manual regeneration

For local preview during development:

cd website
pnpm start         # dev server; TypeDoc runs on first start and on file change
pnpm build         # full production build, regenerates the API reference

If TypeDoc itself fails (e.g. missing tsconfig reference, syntax error in src/index.ts), the Docusaurus build fails — fix the underlying TypeScript issue before retrying.