From e5d03f734a03df430febaf487dd5fd694b28c093 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 09:14:51 +0100 Subject: [PATCH] docs: refresh kimi web search setup --- docs/.i18n/glossary.zh-CN.json | 4 +++ docs/cli/configure.md | 10 ++++--- docs/cli/onboard.md | 9 ++++--- docs/providers/moonshot.md | 49 ++++++++++++++++++++++++++++++++++ docs/tools/kimi-search.md | 14 ++++++++++ docs/tools/web.md | 6 +++++ 6 files changed, 86 insertions(+), 6 deletions(-) diff --git a/docs/.i18n/glossary.zh-CN.json b/docs/.i18n/glossary.zh-CN.json index d2e91372f23..05d98f7e425 100644 --- a/docs/.i18n/glossary.zh-CN.json +++ b/docs/.i18n/glossary.zh-CN.json @@ -59,6 +59,10 @@ "source": "BytePlus (International)", "target": "BytePlus（国际版）" }, + { + "source": "Moonshot AI", + "target": "Moonshot AI" + }, { "source": "Additional bundled variants", "target": "其他内置变体" diff --git a/docs/cli/configure.md b/docs/cli/configure.md index f527f28383c..86a4502b6bb 100644 --- a/docs/cli/configure.md +++ b/docs/cli/configure.md @@ -16,9 +16,13 @@ Tip: `openclaw config` without a subcommand opens the same wizard. Use `openclaw config get|set|unset` for non-interactive edits. For web search, `openclaw configure --section web` lets you choose a provider -and configure its credentials. If you choose **Grok**, configure can also show -a separate follow-up step to enable `x_search` with the same `XAI_API_KEY` and -pick an `x_search` model. Other web-search providers do not show that step. +and configure its credentials. Some providers also show provider-specific +follow-up prompts: + +- **Grok** can offer optional `x_search` setup with the same `XAI_API_KEY` and + let you pick an `x_search` model. +- **Kimi** can ask for the Moonshot API region (`api.moonshot.ai` vs + `api.moonshot.cn`) and the default Kimi web-search model. Related: diff --git a/docs/cli/onboard.md b/docs/cli/onboard.md index 2e368e36fb3..c49094a0d7f 100644 --- a/docs/cli/onboard.md +++ b/docs/cli/onboard.md @@ -142,9 +142,12 @@ Flow notes: - `quickstart`: minimal prompts, auto-generates a gateway token. - `manual`: full prompts for port/bind/auth (alias of `advanced`). -- In the web-search step, choosing **Grok** can trigger a separate follow-up - prompt to enable `x_search` with the same `XAI_API_KEY` and optionally pick - an `x_search` model. Other web-search providers do not show that prompt. +- In the web-search step, some providers can trigger provider-specific + follow-up prompts: + - **Grok** can offer optional `x_search` setup with the same `XAI_API_KEY` + and an `x_search` model choice. + - **Kimi** can ask for the Moonshot API region (`api.moonshot.ai` vs + `api.moonshot.cn`) and the default Kimi web-search model. - Local onboarding DM scope behavior: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals). - Fastest first chat: `openclaw dashboard` (Control UI, no channel setup). - Custom Provider: connect any OpenAI or Anthropic compatible endpoint, diff --git a/docs/providers/moonshot.md b/docs/providers/moonshot.md index fecf397f38a..244cf8d23af 100644 --- a/docs/providers/moonshot.md +++ b/docs/providers/moonshot.md @@ -37,6 +37,15 @@ openclaw onboard --auth-choice kimi-code-api-key Note: Moonshot and Kimi Coding are separate providers. Keys are not interchangeable, endpoints differ, and model refs differ (Moonshot uses `moonshot/...`, Kimi Coding uses `kimi/...`). +Kimi web search uses the Moonshot plugin too: + +```bash +openclaw configure --section web +``` + +Choose **Kimi** in the web-search section to store +`plugins.entries.moonshot.config.webSearch.*`. + ## Config snippet (Moonshot API) ```json5 @@ -134,10 +143,50 @@ Note: Moonshot and Kimi Coding are separate providers. Keys are not interchangea } ``` +## Kimi web search + +OpenClaw also ships **Kimi** as a `web_search` provider, backed by Moonshot web +search. + +Interactive setup can prompt for: + +- the Moonshot API region: + - `https://api.moonshot.ai/v1` + - `https://api.moonshot.cn/v1` +- the default Kimi web-search model (defaults to `kimi-k2.5`) + +Config lives under `plugins.entries.moonshot.config.webSearch`: + +```json5 +{ + plugins: { + entries: { + moonshot: { + config: { + webSearch: { + apiKey: "sk-...", // or use KIMI_API_KEY / MOONSHOT_API_KEY + baseUrl: "https://api.moonshot.ai/v1", + model: "kimi-k2.5", + }, + }, + }, + }, + }, + tools: { + web: { + search: { + provider: "kimi", + }, + }, + }, +} +``` + ## Notes - Moonshot model refs use `moonshot/`. Kimi Coding model refs use `kimi/`. - Current Kimi Coding default model ref is `kimi/kimi-code`. Legacy `kimi/k2p5` remains accepted as a compatibility model id. +- Kimi web search uses `KIMI_API_KEY` or `MOONSHOT_API_KEY`, and defaults to `https://api.moonshot.ai/v1` with model `kimi-k2.5`. - Override pricing and context metadata in `models.providers` if needed. - If Moonshot publishes different context limits for a model, adjust `contextWindow` accordingly. diff --git a/docs/tools/kimi-search.md b/docs/tools/kimi-search.md index f54aa0bff1c..6df1daf73e8 100644 --- a/docs/tools/kimi-search.md +++ b/docs/tools/kimi-search.md @@ -28,6 +28,14 @@ to produce AI-synthesized answers with citations. +When you choose **Kimi** during `openclaw onboard` or +`openclaw configure --section web`, OpenClaw can also ask for: + +- the Moonshot API region: + - `https://api.moonshot.ai/v1` + - `https://api.moonshot.cn/v1` +- the default Kimi web-search model (defaults to `kimi-k2.5`) + ## Config ```json5 @@ -38,6 +46,8 @@ to produce AI-synthesized answers with citations. config: { webSearch: { apiKey: "sk-...", // optional if KIMI_API_KEY or MOONSHOT_API_KEY is set + baseUrl: "https://api.moonshot.ai/v1", + model: "kimi-k2.5", }, }, }, @@ -56,6 +66,9 @@ to produce AI-synthesized answers with citations. **Environment alternative:** set `KIMI_API_KEY` or `MOONSHOT_API_KEY` in the Gateway environment. For a gateway install, put it in `~/.openclaw/.env`. +If you omit `baseUrl`, OpenClaw defaults to `https://api.moonshot.ai/v1`. +If you omit `model`, OpenClaw defaults to `kimi-k2.5`. + ## How it works Kimi uses Moonshot web search to synthesize answers with inline citations, @@ -69,5 +82,6 @@ Provider-specific filters are not currently supported. ## Related - [Web Search overview](/tools/web) -- all providers and auto-detection +- [Moonshot AI](/providers/moonshot) -- Moonshot model + Kimi Coding provider docs - [Gemini Search](/tools/gemini-search) -- AI-synthesized answers via Google grounding - [Grok Search](/tools/grok-search) -- AI-synthesized answers via xAI grounding diff --git a/docs/tools/web.md b/docs/tools/web.md index 7bc19fba01d..ae84edc5c18 100644 --- a/docs/tools/web.md +++ b/docs/tools/web.md @@ -201,6 +201,12 @@ Provider-specific config (API keys, base URLs, modes) lives under `plugins.entries..config.webSearch.*`. See the provider pages for examples. +When you choose **Kimi** during `openclaw onboard` or +`openclaw configure --section web`, OpenClaw can also ask for: + +- the Moonshot API region (`https://api.moonshot.ai/v1` or `https://api.moonshot.cn/v1`) +- the default Kimi web-search model (defaults to `kimi-k2.5`) + For `x_search`, configure `plugins.entries.xai.config.xSearch.*`. It uses the same `XAI_API_KEY` fallback as Grok web search. Legacy `tools.web.x_search.*` config is auto-migrated by `openclaw doctor --fix`.