API Reference

The API reference is generated from source docstrings. The supported surface is classified in docs/api-surface.toml. That manifest maps every top-level export to its stability class and canonical guide. Prefer top-level praval exports unless a guide explicitly documents a public submodule.

Core API

The praval package re-exports the supported convenience surface. The pages below document the modules that define those objects, avoiding duplicate entries for the same class or function.

praval.app

Explicit application ownership for Praval runtimes.

praval.core.agent

Core Agent class for the Praval framework.

praval.core.reef

Reef Communication System for Praval Framework.

praval.core.registry

Agent and Tool Registry for Praval Framework.

praval.core.exceptions

Custom exceptions for the Praval framework.

Model Runtime

praval.models

Provider-neutral model contracts for Praval.

praval.model_runtime

Provider-neutral model runtime.

praval.providers.registry

Provider registry and model profile catalog.

praval.embeddings

Provider-neutral embedding runtime for Praval memory and RAG paths.

Decorators And Composition

praval.decorators

Decorator-based Agent API for Praval Framework.

praval.composition

Composition utilities for decorator-based agents.

Providers

praval.providers.factory

Factory for creating LLM provider instances.

praval.providers.openai

OpenAI provider implementation for Praval framework.

praval.providers.anthropic

Anthropic provider implementation for Praval framework.

praval.providers.cohere

Cohere provider implementation for Praval framework.

praval.providers.gemini

Gemini provider implementation.

praval.providers.openai_compatible

OpenAI-compatible provider for local and third-party runtimes.

Tool System

praval.tools

Tool decorator and utilities for Praval Framework.

praval.core.tool_registry

Tool Registry for Praval Framework.

Human-in-the-Loop And MCP

praval.hitl.models

HITL domain models.

praval.hitl.policy

Policy helpers for HITL approval gating.

praval.hitl.service

Service facade for HITL operations used by Agent APIs and CLI.

praval.hitl.store

SQLite-backed persistence for HITL interventions and suspended runs.

praval.hitl.runtime

Runtime helpers for provider tool-call HITL gating.

praval.mcp.client

Tools-only MCP client integration for Praval agents.

Memory System

praval.memory.memory_manager

MemoryManager - Unified interface for all Praval agent memory systems

praval.memory.short_term_memory

Short-term working memory for Praval agents

praval.memory.long_term_memory

Long-term vector memory using Qdrant for Praval agents

praval.memory.episodic_memory

Episodic memory for Praval agents - conversation history and experiences

praval.memory.semantic_memory

Semantic memory for Praval agents - knowledge, facts, and concepts

praval.memory.memory_types

Memory types and data structures for Praval agents

Storage System

praval.storage.data_manager

Data Manager - Unified interface for storage operations

praval.storage.base_provider

Base Storage Provider Framework

praval.storage.storage_registry

Storage Registry System

praval.storage.decorators

Storage decorators for Praval agents

praval.storage.providers.filesystem

File system storage provider for Praval framework

praval.storage.providers.postgresql

PostgreSQL storage provider for Praval framework

praval.storage.providers.qdrant_provider

Qdrant vector storage provider for Praval framework

praval.storage.providers.redis_provider

Redis storage provider for Praval framework

praval.storage.providers.s3_provider

S3 object storage provider for Praval framework

Observability

praval.observability.config

Observability Configuration.

praval.observability.tracing.context

Trace context propagation.

praval.observability.tracing.tracer

OpenTelemetry-compatible Tracer implementation.

praval.observability.storage.sqlite_store

SQLite storage backend for traces.

praval.observability.export.console_viewer

Console trace viewer for debugging and local development.

praval.observability.export.otlp_exporter

OTLP (OpenTelemetry Protocol) HTTP exporter.

praval.observability.instrumentation.manager

Instrumentation manager.