API Reference

Welcome to the A2A Node SDK API Reference. This section provides comprehensive documentation for all classes, interfaces, enums, and modules in the SDK.

Package Structure

The A2A Node SDK is organized into several packages, each serving a specific purpose:

Core Package

The core package contains fundamental types, interfaces, and utilities used throughout the SDK.

• Types & Interfaces: Basic data structures and contracts
• Error Handling: Standardized error types and handling
• Validation: Input validation and schema definitions
• Protocol: A2A protocol specifications and implementations

Client Package

The client package provides tools for building applications that communicate with A2A agents.

• MessageClient: Send and receive messages with agents
• TaskClient: Manage task lifecycle and status
• AgentClient: Discover and interact with available agents
• Streaming: Real-time communication capabilities

Server Package

The server package contains components for building A2A-compatible agent servers.

• A2AServer: Main server implementation
• Request Handling: Process incoming A2A requests
• Task Management: Handle task execution and lifecycle
• Agent Execution: Execute agent logic and workflows

Navigation

Use the sidebar to explore specific sections:

• Modules - Package-level documentation
• Classes - All SDK classes with methods and properties
• Interfaces - TypeScript interfaces and types
• Enums - Enumeration types and constants

Getting Started

If you’re new to the A2A Node SDK, we recommend starting with:

1. Getting Started Guide - Basic setup and usage
2. Core Package - Understanding fundamental concepts
3. Client Package - Building client applications
4. Server Package - Creating agent servers

Examples

For practical examples and usage patterns, check out the Examples section in the main documentation.