API Reference¶

Overview¶

The public API of chatomon, generated from the docstrings of the code. There is one page per public module or connector package; each starts with a summary of its members, and every class and function includes its parameters, return values, raised exceptions and, for the main entry points, runnable examples.

Table of Contents¶

Core¶

Page	Module	Contents
Atom	`chatomon.atom`	Declares an agent, validates its orbital chains and builds the native agent
Knowledge	`chatomon.knowledge`	Plain-text knowledge added to the nucleus prompt
Schemas	`chatomon.schemas`	Verdicts, the orbital context, engine decisions and turn reports
Errors	`chatomon.errors`	The exceptions chatomon raises

Engine¶

Page	Module	Contents
Engine	`chatomon.engine`	Runs the orbital chains and turns verdicts into decisions for the connectors

Orbitals¶

Page	Module	Contents
Base	`chatomon.orbitals.base`	The `Orbital` extension point, the `orbital` decorator and `FunctionOrbital`
Judge	`chatomon.orbitals.judge`	`JudgeOrbital` and its structured `JudgeDecision`
Limits	`chatomon.orbitals.limits`	`MessageLengthOrbital` and `TurnLimitOrbital`: caps on length and turns
Principled	`chatomon.orbitals.principled`	ScopeGuard and ClaimExtractor orbitals (extra `principled`)

Connectors¶

Page	Module	Contents
Base	`chatomon.connectors.base`	The `Connector` extension point and `render_guidance`
PydanticAI	`chatomon.connectors.pydantic_ai`	`PydanticAIConnector` (extra `pydantic-ai`)
LangChain	`chatomon.connectors.langchain`	`LangChainConnector` (extra `langchain`)
Microsoft Agent Framework	`chatomon.connectors.maf`	`MAFConnector` and `MAFFoundryConnector` (extras `maf`, `maf-foundry`)
Google ADK	`chatomon.connectors.adk`	`ADKConnector` (extra `adk`)

Observability¶

Page	Module	Contents
Observability	`chatomon.observability`	The tracer, the content policy and the hashing helpers

Studio¶

Page	Module	Contents
Studio	`chatomon.studio.server`	`serve` and `DEFAULT_PORT`: the local studio (extra `studio`)

Exports¶

The packages re-export their main names, so from chatomon import Atom works as well as from chatomon.atom import Atom. Each name is documented in the module that defines it.

`chatomon`¶

Name	Documented in
`Atom`	Atom
`Knowledge`	Knowledge
`Verdict`, `OrbitalContext`, `TurnReport`	Schemas
`ChatomonError`, `ChatomonConfigError`, `MissingExtraError`	Errors
`Orbital`, `orbital`	Orbitals / Base

chatomon.__version__ holds the installed version as a string.

`chatomon.orbitals`¶

Name	Documented in
`Orbital`, `orbital`, `FunctionOrbital`, `OrbitalFunction`	Orbitals / Base
`JudgeOrbital`, `JudgeDecision`	Orbitals / Judge
`MessageLengthOrbital`, `TurnLimitOrbital`	Orbitals / Limits

The Principled Intelligence orbitals are not re-exported: import them from chatomon.orbitals.principled, which needs the principled extra.

`chatomon.connectors`¶

Name	Documented in
`Connector`, `render_guidance`	Connectors / Base

The framework connectors are not re-exported: import them from chatomon.connectors.pydantic_ai, chatomon.connectors.langchain, chatomon.connectors.maf, or chatomon.connectors.adk, which need the matching extra.

`chatomon.connectors.maf`¶

Name	Documented in
`MAFConnector`, `MAFFoundryConnector`	Connectors / Microsoft Agent Framework

`chatomon.studio`¶

Name	Documented in
`serve`, `DEFAULT_PORT`	Studio

Editing the Reference¶

These pages are generated from the docstrings in src/chatomon/: to change them, edit the docstrings, not the files in docs/public/reference/.

Concepts — the mental model behind these objects
Home — overview and table of contents of the documentation

Last Updated: September 2026 Status: Implemented