API Reference#

This reference provides an entry to the OpenRath v2.0.0 API and documents the retained v1-compatible Python façade by its package structure. Each page contains three kinds of information:

Information	Purpose
Source	Corresponding source files for jumping back to the implementation.
Public contract	Common signatures, parameters, return values, and exceptions.
Autodoc	Class/function documentation imported from the current source.

OpenRath v2.0.0#

Reference	Contents
v2.0.0 API reference	Definition, context, runtime, governed adapters, artifacts, deployment, evaluation, observability, events/errors, Agent Server, and clients.

v1-compatible package structure#

Package	Contents
`rath`	Package-level entrypoint.
`rath.session`	`Session`, Provider/sandbox placement, chunks, loop, selection, compression, persistence, lineage.
`rath.backend`	Backend abstractions, sandboxes, persistent sandbox identities, tool payloads, results, registry, stream.
`rath.flow`	Module tree, `AgentParam`, presets, `Selector`, and static `CompiledWorkflow` manifests.
`rath.flow.tool`	`FlowToolCall`, built-in system tools, MCP adapters, backend tool factories, schema merging.
`rath.llm`	`Provider`, request/response types, OpenAI, Anthropic, and optional LiteLLM clients, registry, streaming.
`rath.memory`	Memory backends, stores, op payloads, result types, local backend, OpenViking adapter boundary, registry.
`rath.config`	Split config/credentials, backend presets, EnvSpec registry, and store helpers.
`rath.persistence`	Atomic writes, root layout manifest, and cross-plane GC.
`rath.utils`	Project-root and test environment helpers.