账户 API 参考
Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。
共 10 个端点,其中 5 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /talk/roomsList conversations | 只读 | ?limit integer?offset integer?all boolean | orbit talk rooms listtalk_rooms_list |
POST /talk/roomsCreate a conversation | 读写 | 请求体: 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 createtalk_rooms_create |
GET /talk/rooms/{id}One conversation | 只读 | id integer | orbit talk rooms get <id>talk_rooms_get |
PATCH /talk/rooms/{id}Change a conversation | 读写 | id integer请求体: 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 | 读写 | id integer | orbit talk rooms delete <id>talk_rooms_delete |
PUT /talk/rooms/{id}/passcodeSet or clear the passcode | 读写 | id integer请求体: passcode string | orbit talk rooms passcode <id>talk_rooms_passcode |
POST /talk/rooms/{id}/joinMint a join token for somebody your own backend has already let in | 读写 | id integer请求体: label string, peer_id string, readonly boolean | orbit talk rooms join <id>talk_rooms_join |
GET /talk/rooms/{id}/historyRead a conversation's messages | 只读 | id integer?cursor integer?limit integer | orbit talk rooms history <id>talk_rooms_history |
GET /talk/rooms/{id}/usagePer-minute usage | 只读 | id integer?limit integer?offset integer | orbit talk rooms usage <id>talk_rooms_usage |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /talk/citiesCities that carry conversations, and whether they have room | 只读 | — | orbit talk citiestalk_cities |