Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Video API

Real-time video rooms backed by LiveKit. Two flavors:
  • Scheduled rooms (/v1/video/rooms-scheduled/) — pre-create with a start time, capacity, and recording settings; participants join via signed link.
  • Ad-hoc rooms (/v1/video/rooms) — create and join immediately; useful for “click to start a call” flows.
Base path: /v1/video Authentication: API key (X-API-Key) or session JWT. Token issuance for participants uses your API key.

​
Scheduled rooms

MethodPathPurpose
POST/v1/video/rooms-scheduled/Schedule a room
GET/v1/video/rooms-scheduled/List scheduled rooms
GET/v1/video/rooms-scheduled/{id}Get a scheduled room
POST/v1/video/rooms-scheduled/{id}/joinJoin (issues a participant token)
POST/v1/video/rooms-scheduled/{id}/endEnd the meeting early
POST/v1/video/rooms-scheduled/{id}/recording/startStart recording
POST/v1/video/rooms-scheduled/{id}/recording/stopStop recording

​
Ad-hoc rooms

MethodPathPurpose
POST/v1/video/roomsCreate a room
GET/v1/video/roomsList rooms
GET/v1/video/rooms/{name}Get a room
DELETE/v1/video/rooms/{name}Delete (kicks all participants)
POST/v1/video/rooms/{name}/tokenIssue a participant token

​
Inbound webhook

LiveKit posts room and recording lifecycle events to POST /v1/video/webhook. This endpoint is platform-managed; you don’t call it directly.

​
Example — schedule a room and issue a join token

# 1. Schedule
curl -X POST https://orbit-api.devotel.io/api/v1/video/rooms-scheduled/ \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Onboarding call - Acme",
    "starts_at": "2026-05-10T14:00:00Z",
    "duration_minutes": 30,
    "max_participants": 4,
    "auto_record": true
  }'

# 2. Get a join token for a specific participant
curl -X POST https://orbit-api.devotel.io/api/v1/video/rooms-scheduled/room_abc/join \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "participant_name": "Jane Doe", "participant_id": "user_42" }'
The response includes a LiveKit token; pass it to the LiveKit JS / iOS / Android SDK on the client.

​
See also