API Reference

Complete reference for the Estuary Web SDK classes, events, types, and configuration.

npm: @estuary-ai/sdk

Package Structure

@estuary-ai/sdk
├── EstuaryClient        # Main client class
├── EstuaryError         # Error class with typed error codes
├── ErrorCode            # Enum of all error codes
├── ConnectionState      # Enum of connection states
└── types                # All TypeScript interfaces
    ├── EstuaryConfig
    ├── SessionInfo
    ├── BotResponse
    ├── BotVoice
    ├── SttResponse
    ├── InterruptData
    ├── QuotaExceededData
    ├── CameraCaptureRequest
    ├── LiveKitTokenResponse
    ├── MemoryListOptions
    ├── MemoryListResponse
    └── ... (see Data Models)

Imports

All public exports are available from the package root:

import {
  EstuaryClient,
  EstuaryError,
  ErrorCode,
  ConnectionState,
} from '@estuary-ai/sdk';

Types can be imported the same way:

import type {
  EstuaryConfig,
  EstuaryEventMap,
  SessionInfo,
  BotResponse,
  BotVoice,
  SttResponse,
  VoiceTransport,
} from '@estuary-ai/sdk';

Sections

• EstuaryClient -- Main client class with all methods and properties
• Events and Types -- Complete event map and enums
• Data Models -- All TypeScript interfaces
• Configuration -- EstuaryConfig reference