API Reference¶
Full auto-generated reference for the roomkit public API.
Core¶
- RoomKit — Central orchestrator for rooms, channels, hooks, and storage
- Hooks — Hook engine, registrations, and pipeline results
- Routing — Inbound room routing
- Store — Conversation storage ABC and in-memory implementation
- Realtime — Ephemeral events (typing, presence, read receipts)
- Sources — Event-driven message ingestion (WebSocket, NATS, etc.)
Channels¶
- Channel ABC — Base class for all channels
- Built-in Channels — SMS, RCS, Email, AI, WebSocket, Voice, WhatsApp, Messenger, HTTP
- Voice Channel — VoiceBackend, STTProvider, TTSProvider, voice events
Models¶
- Room & Timers — Room model and timer configuration
- Events & Content — RoomEvent, content types, EventSource
- Channel Models — ChannelBinding, ChannelCapabilities, ChannelOutput, RateLimit, RetryPolicy
- Participants & Identity — Participant, Identity, IdentityResult
- Delivery — InboundMessage, InboundResult, DeliveryResult, ProviderResult
- Hooks & Side Effects — HookResult, InjectedEvent, Task, Observation
- Enums — All enumerations