Stream API reference

Stream API.

16 endpoints, 7 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.

streams

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /stream/streams` List live channels	read	`?limit` integer `?offset` integer	`orbit stream streams list` `stream_streams_list`
`POST /stream/streams` Create a channel; the stream key is in the response and is never shown again	write	body: `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 create` `stream_streams_create`
`GET /stream/streams/{id}` Get a channel and its current state	read	`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	write	`id` integer body: `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)	write	`id` integer	`orbit stream streams delete <id>` `stream_streams_delete`

key

Endpoint	Scope	Parameters	CLI · MCP tool
`POST /stream/streams/{id}/key` Issue a new stream key; the broadcast on air is not interrupted unless revoke_now is set	write	`id` integer body: `revoke_now` boolean	`orbit stream key rotate <id>` `stream_key_rotate`

General

Endpoint	Scope	Parameters	CLI · MCP tool
`POST /stream/streams/{id}/stop` End the broadcast that is on air	write	`id` integer	`orbit stream stop <id>` `stream_stop`
`GET /stream/cities` Cities that accept ingest, and whether they have room	read	—	`orbit stream cities` `stream_cities`

sessions

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /stream/streams/{id}/sessions` Past broadcasts: when, how long, how it ended	read	`id` integer `?limit` integer `?offset` integer	`orbit stream sessions list <id>` `stream_sessions_list`

programme

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /stream/streams/{id}/programme` What this channel plays when nobody is publishing to it	read	`id` integer	`orbit stream programme get <id>` `stream_programme_get`
`PUT /stream/streams/{id}/programme` Replace the programme, items and order included	write	`id` integer body: `enabled` boolean, `mode` loop \| relay, `items` object[], `updated_at` string	`orbit stream programme save <id>` `stream_programme_save`

recordings

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /stream/streams/{id}/recordings` Past recordings for this channel	read	`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	write	`id` integer `rec_id` string	`orbit stream recordings delete <id> <rec_id>` `stream_recordings_delete`
`POST /stream/streams/{id}/recordings/{rec_id}/reexport` Push the objects we are holding for this recording into your own bucket	write	`id` integer `rec_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	read	`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	write	`rec_id` string body: `title` string, `description` string, `visibility` public \| unlisted \| private, `passcode` string	`orbit stream recordings update <rec_id>` `stream_recordings_update`

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