API Reference#

This section organizes the public API by the actual 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.

Package structure#

Package	Contents
`rath`	Package-level entrypoint.
`rath.session`	`Session`, chunks, loop, compression, persistence, lineage, registry.
`rath.backend`	Backend abstractions, sandboxes, persistent sandbox identities, tool payloads, results, registry, stream.
`rath.flow`	`Workflow`, `AgentParam`, `Agent`, `Compressor`.
`rath.flow.tool`	`FlowToolCall`, built-in system tools, MCP adapters, backend tool factories, schema merging.
`rath.llm`	`Provider`, request/response types, OpenAI and Anthropic clients, client registry, streaming.
`rath.memory`	Memory backends, stores, op payloads, result types, local backend, OpenViking adapter boundary, registry.
`rath.config`	Persistent `~/.openrath/config.json` schema, path resolution, and store helpers.
`rath.utils`	Project-root and test environment helpers.