API Reference

Full rustdoc for every public type in the workspace, auto-generated from the /// comments on each type, function, and module. Use this when you need to know the exact shape of a struct, the methods on a trait, or what a function returns — anything the generated reference exposes better than prose can.

Open the rustdoc →

How to navigate it

The sidebar on the left lists every crate in the workspace
Click zeroclaw-api first — that's where the public traits (Provider, Channel, Tool) live
Use cmd/ctrl+F in the rustdoc page to search within a crate
Click on any trait to see implementors across the workspace

Crate index

Crate	What it exposes
`zeroclaw`	Top-level umbrella with re-exports
`zeroclaw-api`	Public traits: `Provider`, `Channel`, `Tool`, `StreamEvent`
`zeroclaw-config`	Config schema, autonomy types, secrets
`zeroclaw-runtime`	Agent loop, security, SOP, onboarding
`zeroclaw-providers`	Every LLM-provider implementation
`zeroclaw-channels`	Messaging integrations
`zeroclaw-gateway`	HTTP/WebSocket gateway
`zeroclaw-tools`	Agent-callable tools
`zeroclaw-memory`	Conversation memory, embeddings
`zeroclaw-plugins`	WASM plugin host
`zeroclaw-hardware`	GPIO / I2C / SPI / USB
`zeroclaw-infra`	Tracing, metrics

See Architecture → Crates for a plain-English description of how the crates fit together.

Regenerating the API reference

The rustdoc ships with every doc deploy. For local builds:

bash

cargo mdbook refs     # generates CLI + config reference + rustdoc
cargo mdbook build    # rebuilds the full book including rustdoc bridge

See Maintainers → Docs & Translations.