Realtime API 参考

Realtime API。

共 9 个端点,其中 4 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。

01

rooms

端点权限参数CLI · MCP 工具
GET /rtc/rooms
List rooms		只读?limit integer
?offset integer
?all boolean		orbit realtime rooms list
realtime_rooms_list
POST /rtc/rooms
Create a room		读写请求体: 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 stringorbit realtime rooms create
realtime_rooms_create
GET /rtc/rooms/{id}
Get a room		只读id integerorbit realtime rooms get <id>
realtime_rooms_get
PATCH /rtc/rooms/{id}
Change a room's name, size, link access, passcode or verification		读写id integer
请求体: 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		读写id integerorbit realtime rooms delete <id>
realtime_rooms_delete
02

通用

端点权限参数CLI · MCP 工具
GET /rtc/cities
Cities that accept rooms, and whether they have room		只读—orbit realtime cities
realtime_cities
POST /rtc/rooms/{id}/join
Get the node and short-lived token for one participant		读写id integer
请求体: label string, peer_id string, near object, readonly boolean		orbit realtime join <id>
realtime_join
03

recordings

端点权限参数CLI · MCP 工具
GET /rtc/rooms/{id}/recordings
Past recorded calls in this room, with one file per participant		只读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		读写id integer
rec_id string		orbit realtime recordings delete <id> <rec_id>
realtime_recordings_delete
继续

相关文档

账户 API 参考

Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

组织 API 参考

Orbit API 中 组织 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

服务 API 参考

Orbit API 中 服务 的全部 15 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

← 全部文档