AiAgentSdk

🔌

WebSocket Communication

Real-time bidirectional communication with automatic reconnection and exponential backoff for reliability.

🔐

Multiple Auth Strategies

Support for Anonymous, Pre-Auth, PKCE, and Client Credentials authentication methods.

📬

Message Queuing

Automatic message queuing when offline with seamless delivery on reconnection.

🎯

Type-Safe Events

Full TypeScript support with strongly-typed events and comprehensive type definitions.

📝

Transcript Management

Built-in transcript storage with filtering, serialization, and export capabilities.

🛡️

Error Handling

Comprehensive error handling with typed errors that protect your application from crashes.

🧠

Context Persistence

Automatic context caching and restoration on reconnect for seamless user experiences.

🌐

Universal Compatibility

Works in both Browser and Node.js environments with zero framework dependencies.

Quick Start

The example below uses the pre-auth option — your server obtains an access token and passes it to the SDK. To generate one, follow the instructions for Generating An Access Token using PKCE.

Required scopes:

core.aiservices.read

knowledge.portalmgr.manage

core.customermgr.read (required for AI Agent for Customer Self Service only)

bash

npm install @egain/ai-agent-sdk

typescript

import { AiAgent } from "@egain/ai-agent-sdk";

const agent = new AiAgent({
  id: "your-agent-id",
  endpoint: "https://your-endpoint.com",
  auth: { type: "pre-auth", accessToken: "your-access-token" },
  autoConnect: true
});

await agent.initialize();

agent.on("agentMessage", (event) => {
  console.log("Agent:", event.payload.message?.content);
});

await agent.send("Hello, agent!");

Why This SDK?

🏢 Enterprise-Ready

Built for production use with comprehensive logging, error handling, and connection management.

⚡ Developer Experience

TypeScript-first design with excellent IDE support, autocomplete, and inline documentation.

🔧 Flexible Architecture

Extensible message handlers, pluggable cache adapters, and customizable authentication strategies.

📦 Lightweight

Tree-shakable with zero framework dependencies. Use only what you need.

@egain/ai-agent-sdkEnterprise AI Agent SDK