API Reference
Complete API documentation for the @vowel.to/client SDK.
Modules
Core Module
The core module provides the main Vowel class, adapter factories, configuration interfaces, and utility types for integrating voice AI into any web application.
- Core Module Overview
- Classes —
Vowelclass - Functions — Adapter factories and component creators
- Interfaces — Configuration and prop types
- Type Aliases — Type definitions
- Variables — Constants and defaults
React Module
The React module re-exports core types and components optimized for React applications, including providers, hooks, and UI components.
Quick Links
| Category | Key APIs |
|---|---|
| Core | Vowel, VowelConfig |
| Adapters | createDirectAdapters, createControlledAdapters, createTanStackAdapters, createNextJSAdapters |
| React | VowelProvider, useVowel, VowelAgent |
| Actions | ActionHandler, VowelAction |
| UI Components | VowelMicrophone, FloatingMicButton, VowelSettingsModal |
| Floating Cursor | FloatingCursorProvider, useFloatingCursor |
See Also
- Client Guide — Integration concepts and setup
- Recipes — Practical examples and patterns