WebSocket Quickstart
Build a browser-based voice agent with mic input, audio playback, and interruption-handling.
API reference
See the full event schemas for the Realtime API.
Inworld’s Realtime API is currently in research preview. Please share any feedback with us via the feedback form in Portal or in Discord.
Key Features
- WebSocket transport: Connect over WebSocket with a standard event schema. WebRTC support coming soon.
- Automatic interruption-handling and turn-taking: Your agent will manage conversations naturally and be resilient to user barge-in.
- Router support: Utilize Inworld SmartRouters to enable a single agent to dynamically handle different user cohorts, or to facilitate A/B tests.
- OpenAI compatibility: Drop-in replacement for the OpenAI Realtime API with a simple migration path.
Guides
Using realtime models
Configure sessions, send input, and orchestrate responses.
Managing conversations
Session lifecycle and conversation events.
OpenAI migration
Step-by-step guide to switch from OpenAI to Inworld.