Skip to main content

API Reference

Complete reference documentation for the Estuary Python SDK.

Modules​

ModuleDescription
EstuaryClientMain client class -- connection, text, voice, vision, and REST sub-clients
ConfigurationEstuaryConfig dataclass and related options
Events & TypesEvent names, callback signatures, enums
Data ModelsAll dataclass types for responses, memory, characters, players

Quick Import Guide​

# Main client
from estuary_sdk import EstuaryClient, EstuaryConfig

# Enums
from estuary_sdk import ConnectionState, VoiceMode, VoiceTransport

# Error handling
from estuary_sdk import EstuaryError, ErrorCode

# Data models (responses)
from estuary_sdk import BotResponse, BotVoice, SttResponse, SessionInfo

# Memory models
from estuary_sdk import (
    MemoryData, MemoryGraph, GraphNode, GraphEdge,
    CoreFact, MemorySearchResult, MemoryTimeline,
)

# Character models
from estuary_sdk import Character, CharacterListResponse

# Player models
from estuary_sdk import PlayerConversation, PlayerStats, PlayerMessage

# Installed SDK version
from estuary_sdk import __version__

All public types are exported from the top-level estuary_sdk package.

Package Version​

estuary_sdk.__version__ is the installed package version as a string. It is the version the SDK reports to the server in the X-Estuary-Client header on every REST request, so it is the value to quote in a bug report:

import estuary_sdk

print(estuary_sdk.__version__)   # e.g. "0.6.1"

See Client Identification for what the header is used for.

Last updated