账户 API 参考
Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。
Stream API 参考
Stream API。
共 16 个端点,其中 7 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。
01
streams
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /stream/streamsList live channels | 只读 | ?limit integer?offset integer | orbit stream streams liststream_streams_list |
POST /stream/streamsCreate a channel; the stream key is in the response and is never shown again | 读写 | 请求体: name* string, visibility public | unlisted, placement city | anycast, city string, renditions integer, record boolean, latency_mode low | standard, delay_s integer, quality high | standard, watermark off | br | tl, allow_rtmp boolean, realtime_play boolean, recording_store object, enabled boolean | orbit stream streams createstream_streams_create |
GET /stream/streams/{id}Get a channel and its current state | 只读 | id integer | orbit stream streams get <id>stream_streams_get |
PATCH /stream/streams/{id}Rename, change visibility, enable or disable, allow plain RTMP, burn in a watermark | 读写 | id integer请求体: name* string, visibility public | unlisted, placement city | anycast, city string, renditions integer, record boolean, latency_mode low | standard, delay_s integer, quality high | standard, watermark off | br | tl, allow_rtmp boolean, realtime_play boolean, recording_store object, enabled boolean | orbit stream streams update <id>stream_streams_update |
DELETE /stream/streams/{id}Delete a channel (ends the broadcast if it is on air) | 读写 | id integer | orbit stream streams delete <id>stream_streams_delete |
02
key
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
POST /stream/streams/{id}/keyIssue a new stream key; the broadcast on air is not interrupted unless revoke_now is set | 读写 | id integer请求体: revoke_now boolean | orbit stream key rotate <id>stream_key_rotate |
03
通用
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
POST /stream/streams/{id}/stopEnd the broadcast that is on air | 读写 | id integer | orbit stream stop <id>stream_stop |
GET /stream/citiesCities that accept ingest, and whether they have room | 只读 | — | orbit stream citiesstream_cities |
04
sessions
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /stream/streams/{id}/sessionsPast broadcasts: when, how long, how it ended | 只读 | id integer?limit integer?offset integer | orbit stream sessions list <id>stream_sessions_list |
05
programme
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /stream/streams/{id}/programmeWhat this channel plays when nobody is publishing to it | 只读 | id integer | orbit stream programme get <id>stream_programme_get |
PUT /stream/streams/{id}/programmeReplace the programme, items and order included | 读写 | id integer请求体: enabled boolean, mode loop | relay, items object[], updated_at string | orbit stream programme save <id>stream_programme_save |
06
recordings
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /stream/streams/{id}/recordingsPast recordings for this channel | 只读 | id integer?limit integer?offset integer | orbit stream recordings list <id>stream_recordings_list |
DELETE /stream/streams/{id}/recordings/{rec_id}Delete a recording's stored objects now; the billing record is kept | 读写 | id integerrec_id string | orbit stream recordings delete <id> <rec_id>stream_recordings_delete |
POST /stream/streams/{id}/recordings/{rec_id}/reexportPush the objects we are holding for this recording into your own bucket | 读写 | id integerrec_id string | orbit stream recordings reexport <id> <rec_id>stream_recordings_reexport |
GET /stream/recordings/{rec_id}One recording by its public id; a public subset for a recording you do not own | 只读 | rec_id string | orbit stream recordings get <rec_id>stream_recordings_get |
PATCH /stream/recordings/{rec_id}Set a recording's title, description, visibility or passcode | 读写 | rec_id string请求体: title string, description string, visibility public | unlisted | private, passcode string | orbit stream recordings update <rec_id>stream_recordings_update |