Developer documentation
Free to read · no accountVoltKit RTC documentation
Everything you need to add live video and voice rooms, realtime chat, one-to-many broadcast and in-app music to your product: a quickstart, guides, the SDKs and the full API.
Install an SDK
- JavaScript (browser)
$ npm install @voltkit-rtc/client - Node.js (server)
$ npm install @voltkit-rtc/server - Flutter (iOS and Android)
$ flutter pub add voltkit_rtc
New here? Read these first
Get started
Your first live room, and how secrets, tokens and roles fit together.
Quickstart
Create a project, call the API with your secret, and put two people in a live video room. The shortest path from sign-up to a working call.
Updated
Authentication
How VoltKit RTC authenticates your backend and your users: API secrets, short-lived room tokens, the four roles, and how to rotate a secret safely.
Updated
Build
The things you build with: rooms, chat, broadcast and in-app music.
Rooms
Create and manage VoltKit RTC rooms: hosts and co-hosts, admitting viewers, moderation, room metadata, lifetime and the limits that apply.
Updated
Video quality
Every quality on every project, billed by the media used: 30/60 fps, adaptive layers, viewer quality choices, screen sharing and device troubleshooting.
Updated
Chat
Add realtime chat with VoltKit RTC: messages in every room, chat-only connections for large audiences, direct messages, moderation and history.
Updated
Broadcast
Stream one publisher to any number of viewers with VoltKit RTC: WHIP ingest, LL-HLS and WebRTC playback, CDN delivery, and public or token-protected streams.
Updated
Music
Play music in a VoltKit RTC live stream straight from your app, not through the microphone, with separate switches and volume for music and voice.
Updated
Screen sharing
Share a screen beside your camera, with adaptive detail and motion modes, optional tab audio and automatic stop handling.
Updated
Recording
Record camera broadcasts directly to Cloudflare R2 with prepaid recording credit, bounded uploads, private playback and 90-day retention.
Updated
SDKs
Client and server libraries, with install steps and their full API.
JavaScript (browser)
Use @voltkit-rtc/client in a web app: join a VoltKit RTC room, publish camera and microphone, add chat, and publish a live broadcast over WHIP.
Updated
Flutter
Use the voltkit_rtc package in a Flutter app: join a VoltKit RTC room, publish camera and microphone, add chat, and go live with a broadcast.
Updated
Node.js (server)
Use @voltkit-rtc/server in your backend: create rooms, mint tokens, moderate chat, manage broadcasts, read usage and balance, and verify webhooks.
Updated
Android (Kotlin)
NewThe VoltKit RTC Kotlin SDK: join a room from an Android app, publish camera and microphone, add chat, go live over WHIP and put in-app music on air.
Updated
iOS (Swift)
NewThe VoltKitRTC Swift package: join a VoltKit RTC room from an iPhone app, publish camera and microphone, add chat, go live over WHIP and stream in-app music.
Updated
Operate
Running it in production: webhooks, usage and billing, and troubleshooting.
Webhooks
Receive VoltKit RTC events on your server when rooms start and end, people join and leave, or streams go live, and verify each request's signature.
Updated
Usage and billing
RTC billing: one prepaid VoltKit Wallet, rates per 1,000 participant-minutes for the media used, free and bought minutes first, the trial and limits.
Updated
Troubleshooting
Tell device, network and service problems apart in VoltKit RTC: soft or frozen video, echo, silent audio, blocked connections and camera errors, with fixes.
Updated
Reference
Every endpoint, every field and every error code.
API reference
Every VoltKit RTC endpoint with its request, response, errors and the SDK call that wraps it: rooms, tokens, chat, broadcast, usage and realtime.
Updated
Errors
Every error VoltKit RTC can return, from the REST API and the realtime connection: what each code means, whether to retry, and how the SDKs surface it.
Updated