API Reference

Complete reference documentation for all Estuary SDK components, interfaces, and types.

Overview

The Estuary SDK is organized into several layers:

Layer	Components	Description
Core	EstuaryClient, EstuaryHttpClient, EstuaryConfig, ConnectionState	Low-level WebSocket and REST communication
Components	EstuaryManager, EstuaryCharacter, EstuaryCredentials, EstuaryMicrophone	High-level API for building experiences
Actions	EstuaryActionManager, EstuaryActions, ParsedAction	Action parsing and event dispatch
Camera	EstuaryCamera (example), CameraCaptureRequest	Server-driven vision and image capture
Models	SessionInfo, BotResponse, BotVoice, SttResponse, InterruptData, AgentResponse, ModelStatusResponse, CharacterListResponse	Data structures
Utilities	AudioConverter, setInternetModule	Helper functions

Quick Navigation

• Core Components - Low-level client and configuration
• Component Layer - High-level components for Lens Studio
• Action System - Action parsing and events
• Camera Module - Vision and image capture
• Data Models - Response and session types
• Utilities - Audio conversion and module setup
• HTTP Client - REST API for character management and 3D models

Import Pattern

All SDK exports can be imported from the main module:

import {
    // Core
    EstuaryClient,
    EstuaryHttpClient,
    EstuaryConfig,
    ConnectionState,
    
    // Components
    EstuaryManager,
    EstuaryCharacter,
    EstuaryCredentials,
    EstuaryMicrophone,
    
    // Actions
    EstuaryActionManager,
    EstuaryActions,
    ParsedAction,
    
    // Camera
    CameraCaptureRequest,
    
    // Models
    SessionInfo,
    BotResponse,
    BotVoice,
    SttResponse,
    InterruptData,
    AgentResponse,
    ModelStatusResponse,
    CharacterListResponse,
    
    // Utilities
    floatToPCM16,
    setInternetModule,
} from 'estuary-lens-studio-sdk';