Quickstart

Get a video room running in under 5 minutes.

1. Get an API key

Sign up at app.relaykit.live and create an API key from the dashboard.

2. Create a room

curl -X POST https://api.relaykit.live/api/v1/rooms \
  -H "Authorization: Bearer rk_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"displayName": "My Room", "maxParticipants": 10}'

3. Generate a participant token

curl -X POST https://api.relaykit.live/api/v1/token \
  -H "Authorization: Bearer rk_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"roomId": "room-uuid", "participantIdentity": "user_123"}'

4. Connect with the React SDK

npm install @relaykit/react

import { RelayKitProvider, useRelayKit } from '@relaykit/react'

function App() {
  return (
    <RelayKitProvider apiKey="rk_live_xxxx" apiUrl="https://api.relaykit.live">
      <VideoRoom roomId="room-uuid" identity="user_123" />
    </RelayKitProvider>
  )
}