API reference

The public surface a host integrates against, generated from the docstrings. Start with Retold.open for private per-user memory. Use build_runtime, explicit principals, scopes, and grants when a host needs framework adapters or shared memory.

Page	What it covers
Configuration	RetoldConfig and every section: store, embedding, reranker, retrieval, gate, ingestion, policy, sessions. load_config reads one YAML file.
Runtime and host	build_runtime and MemoryRuntime; MemoryHost for grants and user provisioning.
Models	The record envelope, Principal, Scope, search requests and results, candidates, and explanations.
Tools	The five tool handlers and the JSON schemas the adapters register.
Session hooks and extraction	SessionHooks, the session buffer, the ingestor, and the extraction runner.
Retrieval	The retriever, the gate, and the reranker with its timeout and fallback.
Utility-aware policy	Gap and admission protocols, the orchestrator, turn decisions, activation, bundles, and metrics.
Adapters	The Deep Agents and CrewAI adapters and what every adapter shares.
Operations	Expiry, retention, erasure, re-embedding, snapshots, and due-review flagging.

Everything not listed here is internal and may change without notice.