API Reference
This is the complete API reference for the @a2aletheia/a2a package. All public classes, functions, and types are documented here with detailed descriptions and usage examples.
Navigation
| Reference | Description |
|---|---|
| AletheiaA2A | Main client for discovery, connection, and trusted messaging |
| TrustedAgent | Connection handle with trust metadata and context tracking |
| PeerAgent | Full-duplex agent for both sending and receiving messages |
| Agent Selectors | Built-in strategies for agent selection |
| Context Store | Redis-backed conversation persistence |
| Errors | All error classes and handling patterns |
| Types | All TypeScript types and interfaces |
| Flow Types | Orchestrator-agent communication for user flows |
| Orchestrator Protocol | AgentCard extension for orchestrator capabilities |
Type Definitions
Each API reference page includes inline TypeScript type definitions for all parameters, return values, and interfaces. These types are also exported from the package for use in your applications.
More Resources
For step-by-step guides and tutorials, see the Guides section.