Skip to main content

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
├── SDK_VERSION          # Package version string
└── 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,
  SDK_VERSION,
} from '@estuary-ai/sdk';

SDK_VERSION is the package's own version string, matching the version field in package.json. The SDK sends it on every REST request as the X-Estuary-Client header (estuary-ts-sdk/${SDK_VERSION}), and you can read it to report the SDK version from your own app or bug reports. See Client identification.

Types can be imported the same way:

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

Sections​

Last updated