Skip to content

docs(zh): rewrite the server API reference #3483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liruifengv wants to merge 47 commits into
base: main
Choose a base branch
from
+7,111 −1,617
Open

docs(zh): rewrite the server API reference #3483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
44073b2
docs(zh): rewrite the server API reference as typed endpoint and fram…
liruifengv Sep 2, 2026
6eae8a5
docs(zh): drop the API walkthrough section entirely
liruifengv Sep 2, 2026
5a6be67
docs(zh): drop the WebSocket lifecycle section from the server API re…
liruifengv Sep 2, 2026
71d7e40
docs(zh): trim the server API reference opening to one sentence
liruifengv Sep 2, 2026
ebfaf18
docs(zh): drop the experimental notice from the server API reference
liruifengv Sep 2, 2026
8f8b655
docs(zh): drop the address section from the server API reference
liruifengv Sep 2, 2026
d7ad1ef
docs(zh): restructure the auth section as how-to, failure shape, and …
liruifengv Sep 2, 2026
f891b5e
docs(zh): drop the default-auth and token-rotation sentences from the…
liruifengv Sep 2, 2026
8f674a0
docs(zh): replace the envelope concept with a defined ResponseType
liruifengv Sep 2, 2026
9f76602
docs(zh): move non-zero-code data shapes into the endpoint entries
liruifengv Sep 2, 2026
219e9c8
docs(zh): add a complete error code section with a TODO placeholder
liruifengv Sep 2, 2026
e3c958e
docs(zh): link the error code ranges section to the complete error co…
liruifengv Sep 2, 2026
73cfae2
docs(zh): regroup the REST endpoints from 27 registry domains into 6 …
liruifengv Sep 2, 2026
d1438c2
docs(zh): split the service-and-account domain into service and account
liruifengv Sep 2, 2026
7e03207
docs(zh): move GET /auth from the service domain to the account domain
liruifengv Sep 2, 2026
729cfcd
docs(zh): drop duplicated domain intros and the single-block divider
liruifengv Sep 2, 2026
1fb22a0
docs(zh): drop the divider that duplicated the service domain name
liruifengv Sep 2, 2026
b7c874e
docs(zh): classify the type dictionary by REST and WS with TypeScript…
liruifengv Sep 2, 2026
f6e2cff
docs(zh): split the tasks-and-terminal domain into tasks and terminal
liruifengv Sep 2, 2026
446586d
docs(zh): rewrite the service module as the endpoint format reference
liruifengv Sep 2, 2026
3286eea
docs(zh): split config and models/providers out of the service domain
liruifengv Sep 2, 2026
78d8224
docs(zh): demote endpoint headings to h4 so the outline only shows do…
liruifengv Sep 2, 2026
7ba51a1
docs(zh): restore the REST API umbrella heading with domains at h3
liruifengv Sep 2, 2026
a1d9679
docs(zh): state the full ResponseType generic in every response body …
liruifengv Sep 2, 2026
7a1abe8
docs(zh): unwrap type links from inline code so anchors work
liruifengv Sep 2, 2026
50a9bef
docs(zh): add T-MetaResponse to the type dictionary and reference it …
liruifengv Sep 2, 2026
5f71cd0
docs(zh): add trigger-event lines to the finalized reference domains
liruifengv Sep 2, 2026
a9e8bbf
docs(zh): link every named type in the finalized reference domains
liruifengv Sep 2, 2026
0ce6748
docs(zh): normalize the account domain to the endpoint format
liruifengv Sep 2, 2026
6bcbdc6
docs(zh): normalize the workspace-and-session domain to the endpoint …
liruifengv Sep 2, 2026
f32c389
docs(zh): normalize the conversation domain to the endpoint format
liruifengv Sep 2, 2026
8f57712
docs(zh): normalize the task domain to the endpoint format
liruifengv Sep 2, 2026
950c842
docs(zh): normalize the terminal domain to the endpoint format
liruifengv Sep 2, 2026
2e4c7f0
docs(zh): normalize the extension domain to the endpoint format
liruifengv Sep 2, 2026
176614d
docs(zh): normalize the files-and-misc domain to the endpoint format
liruifengv Sep 2, 2026
c8db359
docs(zh): promote transcript family members to headings and state the…
liruifengv Sep 2, 2026
34e150e
docs(zh): escape pipes inside table cells
liruifengv Sep 2, 2026
8920f8b
docs(zh): add a format sample for the WebSocket frame chapter
liruifengv Sep 2, 2026
1b180e2
docs(zh): use the server's own union names in the WS frame overview
liruifengv Sep 2, 2026
3ff1d7f
docs(zh): use only real system type names in the WS frame overview
liruifengv Sep 2, 2026
4bbdd85
docs(zh): move the frame unions from the overview into their own sect…
liruifengv Sep 2, 2026
8047b75
docs(zh): complete the control frame entries in the server API reference
liruifengv Sep 2, 2026
7d8dd0e
docs(zh): write out all 19 event.* frame entries
liruifengv Sep 2, 2026
396cbc9
docs(zh): write out all 51 agent event frame entries
liruifengv Sep 2, 2026
b2a9946
docs(zh): write transcript and terminal frame sections, drop the supe…
liruifengv Sep 2, 2026
27b8518
docs(zh): link REST trigger-event names to their WS frame entries
liruifengv Sep 2, 2026
7056aeb
docs(zh): drop the stale new-implementation label on transcript frames
liruifengv Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/zh/reference/kimi-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ kimi acp

在当前终端前台运行本地 Kimi 服务 —— 同一个进程同时挂载 REST + WebSocket API 与 web UI —— 并在服务就绪后用默认浏览器打开 web UI。命令会一直挂在终端，直到收到 `SIGINT` / `SIGTERM`（如 `Ctrl-C`）时干净退出。

服务运行时，`GET /openapi.json` 会返回 REST OpenAPI 文档，`GET /asyncapi.json` 会返回本地 WebSocket 协议的 AsyncAPI 文档。用 API 驱动会话的完整流程见[服务 API：用 API 驱动一个会话](./server-api.md#用-api-驱动一个会话)，协议细节见[服务 API](./server-api.md)。
服务运行时，`GET /openapi.json` 会返回 REST OpenAPI 文档，`GET /asyncapi.json` 会返回本地 WebSocket 协议的 AsyncAPI 文档。协议细节见[服务 API](./server-api.md)。

```sh
kimi web # 前台运行服务并打开浏览器
Expand Down
Loading
Loading