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.
Explicit application ownership for Praval runtimes. |
|
Core Agent class for the Praval framework. |
|
Reef Communication System for Praval Framework. |
|
Agent and Tool Registry for Praval Framework. |
|
Custom exceptions for the Praval framework. |
Model Runtime
Provider-neutral model contracts for Praval. |
|
Provider-neutral model runtime. |
|
Provider registry and model profile catalog. |
|
Provider-neutral embedding runtime for Praval memory and RAG paths. |
Decorators And Composition
Decorator-based Agent API for Praval Framework. |
|
Composition utilities for decorator-based agents. |
Providers
Factory for creating LLM provider instances. |
|
OpenAI provider implementation for Praval framework. |
|
Anthropic provider implementation for Praval framework. |
|
Cohere provider implementation for Praval framework. |
|
Gemini provider implementation. |
|
OpenAI-compatible provider for local and third-party runtimes. |
Tool System
Tool decorator and utilities for Praval Framework. |
|
Tool Registry for Praval Framework. |
Human-in-the-Loop And MCP
HITL domain models. |
|
Policy helpers for HITL approval gating. |
|
Service facade for HITL operations used by Agent APIs and CLI. |
|
SQLite-backed persistence for HITL interventions and suspended runs. |
|
Runtime helpers for provider tool-call HITL gating. |
|
Tools-only MCP client integration for Praval agents. |
Memory System
MemoryManager - Unified interface for all Praval agent memory systems |
|
Short-term working memory for Praval agents |
|
Long-term vector memory using Qdrant for Praval agents |
|
Episodic memory for Praval agents - conversation history and experiences |
|
Semantic memory for Praval agents - knowledge, facts, and concepts |
|
Memory types and data structures for Praval agents |
Storage System
Data Manager - Unified interface for storage operations |
|
Base Storage Provider Framework |
|
Storage Registry System |
|
Storage decorators for Praval agents |
|
File system storage provider for Praval framework |
|
PostgreSQL storage provider for Praval framework |
|
Qdrant vector storage provider for Praval framework |
|
Redis storage provider for Praval framework |
|
S3 object storage provider for Praval framework |
Observability
Observability Configuration. |
|
Trace context propagation. |
|
OpenTelemetry-compatible Tracer implementation. |
|
SQLite storage backend for traces. |
|
Console trace viewer for debugging and local development. |
|
OTLP (OpenTelemetry Protocol) HTTP exporter. |
|
Instrumentation manager. |