Talk API reference

Talk API.

10 endpoints, 5 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 /talk/rooms` List conversations	read	`?limit` integer `?offset` integer `?all` boolean	`orbit talk rooms list` `talk_rooms_list`
`POST /talk/rooms` Create a conversation	write	body: `name`* string, `kind` room \| live, `city` string, `visibility` public \| unlisted, `max_peers` integer, `max_kbps` integer, `retention_days` integer, `public_join` boolean, `enabled` boolean	`orbit talk rooms create` `talk_rooms_create`
`GET /talk/rooms/{id}` One conversation	read	`id` integer	`orbit talk rooms get <id>` `talk_rooms_get`
`PATCH /talk/rooms/{id}` Change a conversation	write	`id` integer body: `name`* string, `kind` room \| live, `city` string, `visibility` public \| unlisted, `max_peers` integer, `max_kbps` integer, `retention_days` integer, `public_join` boolean, `enabled` boolean	`orbit talk rooms update <id>` `talk_rooms_update`
`DELETE /talk/rooms/{id}` Delete a conversation and its history	write	`id` integer	`orbit talk rooms delete <id>` `talk_rooms_delete`
`PUT /talk/rooms/{id}/passcode` Set or clear the passcode	write	`id` integer body: `passcode` string	`orbit talk rooms passcode <id>` `talk_rooms_passcode`
`POST /talk/rooms/{id}/join` Mint a join token for somebody your own backend has already let in	write	`id` integer body: `label` string, `peer_id` string, `readonly` boolean	`orbit talk rooms join <id>` `talk_rooms_join`
`GET /talk/rooms/{id}/history` Read a conversation's messages	read	`id` integer `?cursor` integer `?limit` integer	`orbit talk rooms history <id>` `talk_rooms_history`
`GET /talk/rooms/{id}/usage` Per-minute usage	read	`id` integer `?limit` integer `?offset` integer	`orbit talk rooms usage <id>` `talk_rooms_usage`

General

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /talk/cities` Cities that carry conversations, and whether they have room	read	—	`orbit talk cities` `talk_cities`

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