Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 144 show cURL and TypeScript — the two most-used.

Video API

Video endpoints exposed by the Devotel CPaaS API Base path: /api/v1/video Endpoint count: 159

Worked video room samples

The chain a video integration runs end to end: create a scheduled room, mint a participant access token, list the live participants once the room is open, and read the session record (recording) after the room ends. Every request carries your API key (X-API-Key) against https://api.orbit.devotel.io. Successful responses return { data, meta }; failures return Devotel Orbit’s { error, meta } shape — one handler covers both.

1. Create the room

POST /api/v1/video/rooms-scheduled

Creates a scheduled video room. name is 1–200 characters; setting scheduled_at to a future ISO 8601 time parks the room in scheduled status until first join; omit it to go live now. Gate a live or scheduled room behind recurrence, captions, recording, and a per-tier participant cap — inspect the full body in the operation list above. Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "weekly-standup",
  "max_participants": 25,
  "max_duration_minutes": 60
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "weekly-standup",
  "max_participants": 25,
  "max_duration_minutes": 60
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled", headers=headers, json={
  "name": "weekly-standup",
  "max_participants": 25,
  "max_duration_minutes": 60
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled", bytes.NewBuffer([]byte(`{
  "name": "weekly-standup",
  "max_participants": 25,
  "max_duration_minutes": 60
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "name": "weekly-standup",
  "max_participants": 25,
  "max_duration_minutes": 60
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "name": "weekly-standup",
  "max_participants": 25,
  "max_duration_minutes": 60
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "room_id": "3f2b1c9a-9d2e-4f10-8c6a-7b21d44e1a90",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "host_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.host.jwt",
    "ws_url": "wss://media.orbit.devotel.io",
    "composite_egress_id": null,
    "track_egress_id": null,
    "recording_storage": null
  },
  "meta": {
    "request_id": "req_create_room",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

room_id is the UUID you pass to the join (token-mint) and lifecycle calls — persist it. host_token is a LiveKit access JWT for the creator’s own first join; ws_url is the SFU WebSocket endpoint the client SDK connects to (those two are the join URLs — there is no separate url to construct). Egress ids and the storage descriptor populate only when you create the room with recording enabled; null here means recording was not started on create. If scheduled_at was in the future the room stays scheduled until the first participant joins; if it was omitted the room is live now, so composite_egress_id would carry a real id when recording_enabled: true. Cap violations return 400 VIDEO_PARTICIPANTS_CAP_EXCEEDED before any of this happens.

2. Mint the participant token

POST /api/v1/video/rooms-scheduled/{id}/join

One call per participant. identity is who the token is minted for (defaults to your own user id); role is host or participant; participant_tier (viewer / panelist / host / hidden_supervisor) overrides the role-derived grant. Minting under another user’s identity additionally requires an impersonation_reason and the owner or admin role. Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/join" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "identity": "user_abc123",
  "role": "participant",
  "participant_tier": "panelist"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/join', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "identity": "user_abc123",
  "role": "participant",
  "participant_tier": "panelist"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/join", headers=headers, json={
  "identity": "user_abc123",
  "role": "participant",
  "participant_tier": "panelist"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/join", bytes.NewBuffer([]byte(`{
  "identity": "user_abc123",
  "role": "participant",
  "participant_tier": "panelist"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/join')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "identity": "user_abc123",
  "role": "participant",
  "participant_tier": "panelist"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}/join');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "identity": "user_abc123",
  "role": "participant",
  "participant_tier": "panelist"
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Feed token and ws_url to a LiveKit client SDK — the JWT is not an HTTP bearer. expires_at / expires_in_seconds tell your client when to re-mint before the leg drops mid-session. participant_tier and permissions reflect the EFFECTIVE grant: an armed waiting-room lobby downgrades the token to receive-only (lobby_downgraded: true), and the participant/host role downgrade also narrows what the tier schema accepts. See guides/video-room-access-tokens for the token-claim semantics end to end.

3. Read participants and the session record

List the live roster once the room is open, then pull the ended session to read its recording.

GET /api/v1/video/rooms-scheduled/{id}

Returns room (the scheduled-room row, with settings.ingresses stripped for non-admin callers) plus the current participants list.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/{id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "room": {
      "id": "3f2b1c9a-9d2e-4f10-8c6a-7b21d44e1a90",
      "name": "weekly-standup",
      "status": "live",
      "max_participants": 25,
      "recording_url": null,
      "recording_url_expires_at": null
    },
    "participants": [
      {
        "identity": "user_abc123",
        "name": "Ada",
        "joined_at": "2026-09-03T09:16:12.000Z",
        "is_publishing": true
      }
    ]
  },
  "meta": {
    "request_id": "req_read_room",
    "timestamp": "2026-09-03T09:16:12.000Z"
  }
}

After the room ends, one session row per ended room carries the recording:

GET /api/v1/video/sessions/{id}

{
  "data": {
    "id": "vs_2b3c4d5e6f70819a",
    "room_id": "3f2b1c9a-9d2e-4f10-8c6a-7b21d44e1a90",
    "room_name": "weekly-standup",
    "started_at": "2026-09-03T09:16:12.000Z",
    "ended_at": "2026-09-03T09:44:51.000Z",
    "duration_seconds": 1719,
    "max_participants": 25,
    "total_join_events": 7,
    "recording_url": "https://storage.googleapis.com/orbit-recordings-eu/recordings/vs_2b3c4d5e6f70819a.mp4?X-Goog-Signature=sample",
    "recording_url_expires_at": 1787565900000,
    "recording_id": "rec_9f8e7d6c5b4a3162"
  },
  "meta": {
    "request_id": "req_get_session",
    "timestamp": "2026-09-03T09:46:00.000Z"
  }
}

recording_url is a time-limited signed HTTPS URL ready for a <video> element or download; recording_url_expires_at is when to re-fetch the session rather than re-signing the URL yourself. A session whose recording has not finalized yet returns recording_url: null. recording_id is the unified-recordings primary key you use with the Recordings API to mint a guest share link. Poll until it appears, or listen for the video.recording.completed webhook event.

4. Errors

Failures answer { error, meta }. error carries code, status, and message; meta.request_id + timestamp mirror every request. 404 — room expired or unknown. Fetching (GET /rooms-scheduled/{id}) or minting against a room past its expiry hits NOT_FOUND before any SFU work runs. Expiry is the max_duration_minutes TTL you set on create (or the platform default on the room row), so re-create the room rather than retrying the token call.

404

{
  "error": {
    "code": "NOT_FOUND",
    "status": 404,
    "message": "Video room not found"
  },
  "meta": {
    "request_id": "req_read_room",
    "timestamp": "2026-09-03T09:46:00.000Z"
  }
}

429 — concurrent-room cap. A tenant’s concurrent-room cap throttles bursts of room-creation (POST /rooms-scheduled) and token-mint (POST /:id/join) calls. The two write calls are rate-limited per tenant; the fix is to drain ended rooms (list /sessions and skip live ones) before opening more, not to retry the same POST in a loop.

429

{
  "error": {
    "code": "RATE_LIMITED",
    "status": 429,
    "message": "Too many concurrent rooms. Close ended rooms before creating new ones."
  },
  "meta": {
    "request_id": "req_create_room",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Two more envelope codes worth special-casing before the generic handler: 403 PARTICIPANT_TIER_NOT_PERMITTED (the caller’s role cannot mint the requested participant_tier) and 403 IMPERSONATION_NOT_PERMITTED / 400 IMPERSONATION_REASON_REQUIRED on the token-mint path — both mean re-minting without changing the request will fail again the same way. For the embedded-UI version of this same chain (the operator-facing Meetings dashboard that posts to these same endpoints), see guides/video-meetings. For token claims, scopes, and the lobby-downgrade semantics in depth, see guides/video-room-access-tokens.

List avatar-agents

GET /api/v1/video/avatar-agents

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-agents" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-agents", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-agents", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List join-plan

GET /api/v1/video/avatar-agents/{id}/join-plan

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join-plan" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join-plan', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join-plan", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join-plan", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join-plan')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join-plan');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List avatar-video-renders

GET /api/v1/video/avatar-video-renders

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get avatar-video-renders

GET /api/v1/video/avatar-video-renders/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List background-library

GET /api/v1/video/background-library

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/background-library" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/background-library', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/background-library", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/background-library", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/background-library')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/background-library');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List languages

GET /api/v1/video/broadcast-captions/{name}/languages

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/languages" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/languages', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/languages", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/languages", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/languages')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/languages');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List subtitles.vtt

GET /api/v1/video/broadcast-captions/{name}/subtitles.vtt

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/subtitles.vtt" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/subtitles.vtt', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/subtitles.vtt", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/subtitles.vtt", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/subtitles.vtt')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/subtitles.vtt');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get broadcast-viewership

GET /api/v1/video/broadcast-viewership/{name}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List report

GET /api/v1/video/broadcast-viewership/{name}/report

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/report" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/report', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/report", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/report", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/report')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/report');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List capabilities

GET /api/v1/video/captions/capabilities

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/captions/capabilities" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/captions/capabilities', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/captions/capabilities", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/captions/capabilities", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/captions/capabilities')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/captions/capabilities');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get connection-quality

GET /api/v1/video/connection-quality/{name}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List stats

GET /api/v1/video/connection-quality/{name}/participants/{identity}/stats

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/participants/{identity}/stats" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/participants/{identity}/stats', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/participants/{identity}/stats", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/participants/{identity}/stats", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/participants/{identity}/stats')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/participants/{identity}/stats');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List report

GET /api/v1/video/connection-quality/{name}/report

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/report" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/report', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/report", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/report", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/report')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}/report');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get media-diagnostics

GET /api/v1/video/media-diagnostics/{name}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List preflight

GET /api/v1/video/preflight

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/preflight" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/preflight', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/video/preflight", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/video/preflight", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/video/preflight')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/video/preflight');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List chapter-analytics

GET /api/v1/video/recordings/chapter-analytics

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/recordings/chapter-analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/recordings/chapter-analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List room-templates

GET /api/v1/video/room-templates

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/room-templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get room-templates

GET /api/v1/video/room-templates/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List rooms

GET /api/v1/video/rooms

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Room usage analytics

GET /api/v1/video/rooms-analytics/usage

Aggregate video room usage + engagement for the calling tenant over a date window (default last 30 days): total sessions, room-minutes, average/peak concurrent participants, recording success rate, and the never-joined unused_rooms bucket (idle cleanup — NOT a failure). Returns an org-wide summary plus a per-UTC-day daily time series for sessions-over-time charts. Read-only; scoped on video:read (or video:write as a superset).

string

Window start (ISO 8601 date-time). Defaults to 30 days before to.

string

Window end (ISO 8601 date-time). Defaults to now.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-analytics/usage', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List rooms-scheduled

GET /api/v1/video/rooms-scheduled

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get rooms-scheduled

GET /api/v1/video/rooms-scheduled/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List activity

GET /api/v1/video/rooms-scheduled/{id}/activity

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/activity" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/activity', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List bans

GET /api/v1/video/rooms-scheduled/{id}/bans

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bans" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bans', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List chat

GET /api/v1/video/rooms-scheduled/{id}/chat

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List dial-in

GET /api/v1/video/rooms-scheduled/{id}/dial-in

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dial-in" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dial-in', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List hand-queue

GET /api/v1/video/rooms-scheduled/{id}/hand-queue

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-queue" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-queue', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List ingress

GET /api/v1/video/rooms-scheduled/{id}/ingress

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ingress" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ingress', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List invites

GET /api/v1/video/rooms-scheduled/{id}/invites

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invites" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invites', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List livestream

GET /api/v1/video/rooms-scheduled/{id}/livestream

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/livestream" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/livestream', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List dvr

GET /api/v1/video/rooms-scheduled/{id}/livestream/dvr

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/livestream/dvr" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/livestream/dvr', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List recording-consents

GET /api/v1/video/rooms-scheduled/{id}/recording-consents

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording-consents" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording-consents', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List exclusions

GET /api/v1/video/rooms-scheduled/{id}/recording/exclusions

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/exclusions" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/exclusions', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List registration

GET /api/v1/video/rooms-scheduled/{id}/registration

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registration" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registration', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List room-system

GET /api/v1/video/rooms-scheduled/{id}/room-system

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/room-system" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/room-system', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List simulive

GET /api/v1/video/rooms-scheduled/{id}/simulive

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List playout

GET /api/v1/video/rooms-scheduled/{id}/simulive/playout

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive/playout" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive/playout', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List speakers

GET /api/v1/video/rooms-scheduled/{id}/speakers

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/speakers" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/speakers', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Read the SSO restriction policy and arming eligibility

GET /api/v1/video/rooms-scheduled/{id}/sso-policy

Returns the room’s persisted sso_required gate + allowed email domains, plus can_arm — whether the acting session is eligible to enable the restriction. Eligibility is evaluated with the same fail-closed idp-federation verdict the POST’s self-lockout guard applies, so the dashboard can disable the arming toggle instead of surfacing the guaranteed 409 after a click.

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sso-policy" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sso-policy', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List transcripts

GET /api/v1/video/rooms-scheduled/{id}/transcripts

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List export

GET /api/v1/video/rooms-scheduled/{id}/transcripts/export

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts/export" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts/export', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List watch-together

GET /api/v1/video/rooms-scheduled/{id}/watch-together

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List limits

GET /api/v1/video/rooms-scheduled/limits

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/limits" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/limits', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get rooms

GET /api/v1/video/rooms/{name}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List engagement

GET /api/v1/video/rooms/{name}/sessions/{sessionId}/engagement

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/engagement" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/engagement', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List media-metrics

GET /api/v1/video/rooms/{name}/sessions/{sessionId}/media-metrics

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/media-metrics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/media-metrics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List sessions

GET /api/v1/video/sessions

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/sessions" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/sessions', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Get sessions

GET /api/v1/video/sessions/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

List qa-score

GET /api/v1/video/sessions/{id}/qa-score

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa-score" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa-score', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Avatar-agents video

POST /api/v1/video/avatar-agents

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/avatar-agents" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Avatar-video-renders video

POST /api/v1/video/avatar-video-renders

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Verify avatar-video-renders

POST /api/v1/video/avatar-video-renders/verify

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/verify" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/verify', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Background-library video

POST /api/v1/video/background-library

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/background-library" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/background-library', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create cues

POST /api/v1/video/broadcast-captions/{name}/cues

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/cues" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/broadcast-captions/{name}/cues', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create heartbeat

POST /api/v1/video/broadcast-viewership/{name}/heartbeat

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/heartbeat" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/broadcast-viewership/{name}/heartbeat', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create segment

POST /api/v1/video/captions/{name}/segment

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/captions/{name}/segment" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/captions/{name}/segment', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Ephemeral-key captions

POST /api/v1/video/captions/ephemeral-key

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/captions/ephemeral-key" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/captions/ephemeral-key', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Translate captions

POST /api/v1/video/captions/translate

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/captions/translate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/captions/translate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create connection-quality

POST /api/v1/video/connection-quality/{name}

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/connection-quality/{name}', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Interpretation video

POST /api/v1/video/interpretation

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/interpretation" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/interpretation', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create redeem

POST /api/v1/video/invites/{inviteToken}/redeem

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/invites/{inviteToken}/redeem" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/invites/{inviteToken}/redeem', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create media-diagnostics

POST /api/v1/video/media-diagnostics/{name}

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/media-diagnostics/{name}', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Room-templates video

POST /api/v1/video/room-templates

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/room-templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create instantiate

POST /api/v1/video/room-templates/{id}/instantiate

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/instantiate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/instantiate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Rooms video

POST /api/v1/video/rooms

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Rooms-scheduled video

POST /api/v1/video/rooms-scheduled

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create ask

POST /api/v1/video/rooms-scheduled/{id}/ask

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ask" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ask', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create branding

POST /api/v1/video/rooms-scheduled/{id}/branding

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create breakouts

POST /api/v1/video/rooms-scheduled/{id}/breakouts

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/breakouts" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/breakouts', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create move

POST /api/v1/video/rooms-scheduled/{id}/breakouts/{childRoomId}/move/{identity}

string

required

—

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/breakouts/{childRoomId}/move/{identity}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/breakouts/{childRoomId}/move/{identity}', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create broadcast

POST /api/v1/video/rooms-scheduled/{id}/broadcast

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/broadcast" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/broadcast', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create chat

POST /api/v1/video/rooms-scheduled/{id}/chat

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create chat-policy

POST /api/v1/video/rooms-scheduled/{id}/chat-policy

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat-policy" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat-policy', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Clear chat

POST /api/v1/video/rooms-scheduled/{id}/chat/clear

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat/clear" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat/clear', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete chat

POST /api/v1/video/rooms-scheduled/{id}/chat/delete

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat/delete" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat/delete', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create dial-out

POST /api/v1/video/rooms-scheduled/{id}/dial-out

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dial-out" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dial-out', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create dispatch-agent

POST /api/v1/video/rooms-scheduled/{id}/dispatch-agent

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispatch-agent" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispatch-agent', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Dash egress

POST /api/v1/video/rooms-scheduled/{id}/egress/dash

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/dash" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/dash', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Hls egress

POST /api/v1/video/rooms-scheduled/{id}/egress/hls

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/hls" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/hls', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Participants egress

POST /api/v1/video/rooms-scheduled/{id}/egress/participants

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/participants" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/participants', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Rtmp egress

POST /api/v1/video/rooms-scheduled/{id}/egress/rtmp

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/rtmp" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/rtmp', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Stream egress

POST /api/v1/video/rooms-scheduled/{id}/egress/stream

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/stream" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/stream', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create end

POST /api/v1/video/rooms-scheduled/{id}/end

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/end" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/end', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create hand-lower

POST /api/v1/video/rooms-scheduled/{id}/hand-lower

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-lower" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-lower', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Clear hand-queue

POST /api/v1/video/rooms-scheduled/{id}/hand-queue/clear

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-queue/clear" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-queue/clear', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create hand-raise

POST /api/v1/video/rooms-scheduled/{id}/hand-raise

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-raise" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/hand-raise', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create ingress

POST /api/v1/video/rooms-scheduled/{id}/ingress

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ingress" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ingress', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create invites

POST /api/v1/video/rooms-scheduled/{id}/invites

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invites" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invites', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create join

POST /api/v1/video/rooms-scheduled/{id}/join

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/join', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create lock

POST /api/v1/video/rooms-scheduled/{id}/lock

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lock" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lock', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create mute-all

POST /api/v1/video/rooms-scheduled/{id}/mute-all

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mute-all" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mute-all', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create ban

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/ban

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/ban" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/ban', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create kick

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/kick

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/kick" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/kick', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create mute

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/mute

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/mute" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/mute', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create receive-control

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/receive-control

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/receive-control" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/receive-control', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/recording-consent

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/recording-consent" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/recording-consent', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create role

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/role

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/role" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/role', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create tier

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/tier

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/tier" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/tier', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create unmute

POST /api/v1/video/rooms-scheduled/{id}/participants/{identity}/unmute

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/unmute" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/unmute', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create polls

POST /api/v1/video/rooms-scheduled/{id}/polls

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/polls" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/polls', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Close polls

POST /api/v1/video/rooms-scheduled/{id}/polls/close

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/polls/close" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/polls/close', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Vote polls

POST /api/v1/video/rooms-scheduled/{id}/polls/vote

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/polls/vote" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/polls/vote', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create qa

POST /api/v1/video/rooms-scheduled/{id}/qa

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Answer qa

POST /api/v1/video/rooms-scheduled/{id}/qa/answer

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa/answer" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa/answer', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create reactions

POST /api/v1/video/rooms-scheduled/{id}/reactions

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reactions" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reactions', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Exclude-participant recording

POST /api/v1/video/rooms-scheduled/{id}/recording/exclude-participant

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/exclude-participant" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/exclude-participant', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Pause recording

POST /api/v1/video/rooms-scheduled/{id}/recording/pause

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/pause" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/pause', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Resume recording

POST /api/v1/video/rooms-scheduled/{id}/recording/resume

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/resume" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/resume', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Start recording

POST /api/v1/video/rooms-scheduled/{id}/recording/start

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/start" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/start', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Stop recording

POST /api/v1/video/rooms-scheduled/{id}/recording/stop

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/stop" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/stop', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Unexclude-participant recording

POST /api/v1/video/rooms-scheduled/{id}/recording/unexclude-participant

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/unexclude-participant" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/recording/unexclude-participant', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create registrants

POST /api/v1/video/rooms-scheduled/{id}/registrants

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create check-in

POST /api/v1/video/rooms-scheduled/{id}/registrants/{registrantId}/check-in

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants/{registrantId}/check-in" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants/{registrantId}/check-in', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Cancel simulive

POST /api/v1/video/rooms-scheduled/{id}/simulive/cancel

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive/cancel" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive/cancel', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create spotlight

POST /api/v1/video/rooms-scheduled/{id}/spotlight

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/spotlight" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/spotlight', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create sso-policy

POST /api/v1/video/rooms-scheduled/{id}/sso-policy

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sso-policy" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sso-policy', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create waiting-room

POST /api/v1/video/rooms-scheduled/{id}/waiting-room

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/waiting-room" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/waiting-room', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create admit

POST /api/v1/video/rooms-scheduled/{id}/waiting-room/admit/{identity}

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/waiting-room/admit/{identity}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/waiting-room/admit/{identity}', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create deny

POST /api/v1/video/rooms-scheduled/{id}/waiting-room/deny/{identity}

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/waiting-room/deny/{identity}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/waiting-room/deny/{identity}', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Control watch-together

POST /api/v1/video/rooms-scheduled/{id}/watch-together/control

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together/control" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together/control', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Start watch-together

POST /api/v1/video/rooms-scheduled/{id}/watch-together/start

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together/start" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together/start', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Stop watch-together

POST /api/v1/video/rooms-scheduled/{id}/watch-together/stop

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together/stop" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/watch-together/stop', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Clear whiteboard

POST /api/v1/video/rooms-scheduled/{id}/whiteboard/clear

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/clear" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/clear', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Close whiteboard

POST /api/v1/video/rooms-scheduled/{id}/whiteboard/close

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/close" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/close', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Draw whiteboard

POST /api/v1/video/rooms-scheduled/{id}/whiteboard/draw

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/draw" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/draw', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Open whiteboard

POST /api/v1/video/rooms-scheduled/{id}/whiteboard/open

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/open" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/whiteboard/open', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create chat

POST /api/v1/video/rooms/{id}/chat

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create engagement

POST /api/v1/video/rooms/{name}/sessions/{sessionId}/engagement

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/engagement" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/engagement', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create media-metrics

POST /api/v1/video/rooms/{name}/sessions/{sessionId}/media-metrics

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/media-metrics" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}/sessions/sess_6f8a0c2d4e/media-metrics', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create token

POST /api/v1/video/rooms/{name}/token

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/rooms/{name}/token" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}/token', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create qa-score

POST /api/v1/video/sessions/{id}/qa-score

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa-score" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/qa-score', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Create summary

POST /api/v1/video/sessions/{id}/summary

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/summary" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/sessions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/summary', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Webhook video

POST /api/v1/video/webhook

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/video/webhook" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/webhook', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Update registration

PUT /api/v1/video/rooms-scheduled/{id}/registration

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registration" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registration', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Update simulive

PUT /api/v1/video/rooms-scheduled/{id}/simulive

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulive', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Patch avatar-agents

PATCH /api/v1/video/avatar-agents/{id}

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Patch avatar-video-renders

PATCH /api/v1/video/avatar-video-renders/{id}

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Patch room-templates

PATCH /api/v1/video/room-templates/{id}

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Patch rooms-scheduled

PATCH /api/v1/video/rooms-scheduled/{id}

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Patch registrants

PATCH /api/v1/video/rooms-scheduled/{id}/registrants/{registrantId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants/{registrantId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants/{registrantId}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Patch transcripts

PATCH /api/v1/video/rooms-scheduled/{id}/transcripts/{transcriptId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts/{transcriptId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts/{transcriptId}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete avatar-agents

DELETE /api/v1/video/avatar-agents/{id}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-agents/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete avatar-video-renders

DELETE /api/v1/video/avatar-video-renders/{id}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/avatar-video-renders/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete background-library

DELETE /api/v1/video/background-library/{assetId}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/background-library/{assetId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/background-library/{assetId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete room-templates

DELETE /api/v1/video/room-templates/{id}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete branding

DELETE /api/v1/video/rooms-scheduled/{id}/branding

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete chat

DELETE /api/v1/video/rooms-scheduled/{id}/chat

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/chat', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete dash

DELETE /api/v1/video/rooms-scheduled/{id}/egress/dash/{egressId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/dash/{egressId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/dash/{egressId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete hls

DELETE /api/v1/video/rooms-scheduled/{id}/egress/hls/{egressId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/hls/{egressId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/hls/{egressId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete participants

DELETE /api/v1/video/rooms-scheduled/{id}/egress/participants

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/participants" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/participants', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete rtmp

DELETE /api/v1/video/rooms-scheduled/{id}/egress/rtmp/{egressId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/rtmp/{egressId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/rtmp/{egressId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete stream

DELETE /api/v1/video/rooms-scheduled/{id}/egress/stream/{egressId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/stream/{egressId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/egress/stream/{egressId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete ingress

DELETE /api/v1/video/rooms-scheduled/{id}/ingress/{ingressId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ingress/{ingressId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ingress/{ingressId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete invites

DELETE /api/v1/video/rooms-scheduled/{id}/invites/{inviteId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invites/{inviteId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invites/{inviteId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete ban

DELETE /api/v1/video/rooms-scheduled/{id}/participants/{identity}/ban

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/ban" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/participants/{identity}/ban', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete registrants

DELETE /api/v1/video/rooms-scheduled/{id}/registrants/{registrantId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants/{registrantId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/registrants/{registrantId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete spotlight

DELETE /api/v1/video/rooms-scheduled/{id}/spotlight

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/spotlight" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/spotlight', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete transcripts

DELETE /api/v1/video/rooms-scheduled/{id}/transcripts

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms-scheduled/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transcripts', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

Delete rooms

DELETE /api/v1/video/rooms/{name}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/video/rooms/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/video/rooms/{name}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.participant.jwt",
    "token_type": "livekit_access_token",
    "ws_url": "wss://media.orbit.devotel.io",
    "livekit_url": "wss://media.orbit.devotel.io",
    "room_sid": "RM_4a7c9f2b3e1d48a0b6c5d2e8f1a3b7c9",
    "participant_tier": "panelist",
    "lobby_downgraded": false,
    "permissions": {
      "can_publish": true,
      "can_subscribe": true,
      "can_publish_data": true,
      "hidden": false,
      "room_admin": false
    },
    "expires_at": "2026-09-03T10:15:00.000Z",
    "expires_in_seconds": 3600
  },
  "meta": {
    "request_id": "req_mint_token",
    "timestamp": "2026-09-03T09:15:00.000Z"
  }
}

​Video API

​Worked video room samples

​1. Create the room

​2. Mint the participant token

​3. Read participants and the session record

​4. Errors

​List avatar-agents

​List join-plan

​List avatar-video-renders

​Get avatar-video-renders

​List background-library

​List languages

​List subtitles.vtt

​Get broadcast-viewership

​List report

​List capabilities

​Get connection-quality

​List stats

​List report

​Get media-diagnostics

​List preflight

​List chapter-analytics

​List room-templates

​Get room-templates

​List rooms

​Room usage analytics

​List rooms-scheduled

​Get rooms-scheduled

​List activity

​List bans

​List chat

​List dial-in

​List hand-queue

​List ingress

​List invites

​List livestream

​List dvr

​List recording-consents

​List exclusions

​List registration

​List room-system

​List simulive

​List playout

​List speakers

​Read the SSO restriction policy and arming eligibility

​List transcripts

​List export

​List watch-together

​List limits

​Get rooms

​List engagement

​List media-metrics

​List sessions

​Get sessions

​List qa-score

​Avatar-agents video

​Avatar-video-renders video

​Verify avatar-video-renders

​Background-library video

​Create cues

​Create heartbeat

​Create segment

​Ephemeral-key captions

​Translate captions

​Create connection-quality

​Interpretation video

​Create redeem

​Create media-diagnostics

​Room-templates video

​Create instantiate

​Rooms video

​Rooms-scheduled video

​Create ask

​Create branding

​Create breakouts

​Create move

​Create broadcast

​Create chat

​Create chat-policy

​Clear chat

Video API

Worked video room samples

1. Create the room

2. Mint the participant token

3. Read participants and the session record

4. Errors

List avatar-agents

List join-plan

List avatar-video-renders

Get avatar-video-renders

List background-library

List languages

List subtitles.vtt

Get broadcast-viewership

List report

List capabilities

Get connection-quality

List stats

List report

Get media-diagnostics

List preflight

List chapter-analytics

List room-templates

Get room-templates

List rooms

Room usage analytics

List rooms-scheduled

Get rooms-scheduled

List activity

List bans

List chat

List dial-in

List hand-queue

List ingress

List invites

List livestream

List dvr

List recording-consents

List exclusions

List registration

List room-system

List simulive

List playout

List speakers

Read the SSO restriction policy and arming eligibility

List transcripts

List export

List watch-together

List limits

Get rooms

List engagement

List media-metrics

List sessions

Get sessions

List qa-score

Avatar-agents video

Avatar-video-renders video

Verify avatar-video-renders

Background-library video

Create cues

Create heartbeat

Create segment

Ephemeral-key captions

Translate captions

Create connection-quality

Interpretation video

Create redeem

Create media-diagnostics

Room-templates video

Create instantiate

Rooms video

Rooms-scheduled video

Create ask

Create branding

Create breakouts

Create move

Create broadcast

Create chat

Create chat-policy

Clear chat