vowel platform docs

Documentation for the vowel platform

💻

Client

Install the SDK, connect with an app ID or token flow, and integrate with React, Web Components, or vanilla JavaScript

🏗️

Self-Hosted

Deploy Core and the realtime engine on your own infrastructure with operator-focused guidance

🤖

vowelbot

Add vowel to a GitHub repository through a guided onboarding flow at add.vowel.to

☁️

Platform

Hosted platform features are coming soon after the initial self-hosted open-source launch

🧪

Recipes

Start from practical patterns for actions, notifications, navigation, automation, and advanced connection setups

📚

API Reference

Look up the exact SDK classes, functions, types, and React module exports

⚠️ Beta Release — The vowel open-source release is in beta. You may encounter rough edges, incomplete features, or breaking changes. We are actively reviewing and merging community PRs, but please expect some instability as we iterate toward a stable release. Your feedback and contributions are welcome.

Browse The Docs

Client: SDK setup, framework integrations, connection models, and client concepts.
Self-Hosted: Architecture, deployment, configuration, Core, realtime engine, and troubleshooting.
Platform: Hosted platform documentation, including app management, billing, and hosted realtime features.
vowelbot: Guided onboarding for adding vowel to a GitHub repository at add.vowel.to.
Recipes: Task-oriented examples for actions, events, navigation, automation, and advanced flows.
API Reference: Generated reference for SDK modules, classes, functions, hooks, and types.