Realtime API reference

Realtime API.

9 endpoints, 4 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.

rooms

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /rtc/rooms` List rooms	read	`?limit` integer `?offset` integer `?all` boolean	`orbit realtime rooms list` `realtime_rooms_list`
`POST /rtc/rooms` Create a room	write	body: `name`* string, `max_peers` integer, `max_video` integer, `enabled` boolean, `public_join` boolean, `require_verify` boolean, `verify_level` standard \| strict \| maximum, `city` string, `cascade` boolean, `record` boolean, `passcode` string	`orbit realtime rooms create` `realtime_rooms_create`
`GET /rtc/rooms/{id}` Get a room	read	`id` integer	`orbit realtime rooms get <id>` `realtime_rooms_get`
`PATCH /rtc/rooms/{id}` Change a room's name, size, link access, passcode or verification	write	`id` integer body: `name`* string, `max_peers` integer, `max_video` integer, `enabled` boolean, `public_join` boolean, `require_verify` boolean, `verify_level` standard \| strict \| maximum, `city` string, `cascade` boolean, `record` boolean, `passcode` string	`orbit realtime rooms update <id>` `realtime_rooms_update`
`DELETE /rtc/rooms/{id}` Delete a room	write	`id` integer	`orbit realtime rooms delete <id>` `realtime_rooms_delete`

General

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /rtc/cities` Cities that accept rooms, and whether they have room	read	—	`orbit realtime cities` `realtime_cities`
`POST /rtc/rooms/{id}/join` Get the node and short-lived token for one participant	write	`id` integer body: `label` string, `peer_id` string, `near` object, `readonly` boolean	`orbit realtime join <id>` `realtime_join`

recordings

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /rtc/rooms/{id}/recordings` Past recorded calls in this room, with one file per participant	read	`id` integer `?limit` integer `?offset` integer	`orbit realtime recordings list <id>` `realtime_recordings_list`
`DELETE /rtc/rooms/{id}/recordings/{rec_id}` Delete a recording's stored objects now; the billing record is kept	write	`id` integer `rec_id` string	`orbit realtime recordings delete <id> <rec_id>` `realtime_recordings_delete`

Account API reference

Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Organization API reference

Every Organization endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Services API reference

Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation