Skip to content

API reference

The API reference is auto-generated from docstrings in the activegraph package. Symbols are organized by topical module — runtime, graph, behaviors, tools, store, packs, errors, observability — each as a separate page navigated from the sidebar.

Two conventions apply across the reference:

  • Public surface only. Symbols listed in activegraph.__all__ and the pack-level __all__s appear here. Internal symbols (those starting with _, or those not re-exported) are not in the reference; treat them as implementation details.
  • No source dumps. The reference renders the API contract, not the implementation. Readers who want source go to GitHub.

The framework's docstrings are mostly free-form Markdown rather than structured (Google/NumPy/Sphinx). The renderer falls back to raw Markdown for prose-only docstrings; structured sections (Args:, Returns:, Raises:, Examples:) render as labeled blocks where they appear.

Topical reference

  • Runtime — the runtime loop, frames, budget, status.
  • Graph — graph and its primitives (objects, relations, patches, views, events).
  • Behaviors — the behavior decorators and base classes.
  • Tools — the @tool decorator and tool primitives.
  • Store — event stores (in-memory, SQLite, Postgres), URL parsing, migration.
  • Packs — the pack format primitives.
  • Errors — the ActiveGraphError hierarchy.
  • Observability — the metrics protocol and shipped backends.
  • Diligence pack — the v0.9 reference pack.

Docstring coverage

A coverage audit against CONTRACT v1.0 #C2's tier model (100% on public surface, 80% on second ring) is regenerated by scripts/audit_docstrings.py. The current state is in COVERAGE_REPORT.md; the docstring-gate CI commit consumes it as a checklist.