From cc5bd57bd7c3a99cb7ce2fa1bb42d41b5b221560 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Wed, 18 Mar 2026 12:26:01 -0700 Subject: [PATCH] docs: add missing provider pages (google, modelstudio, perplexity, volcengine) and nav entries --- docs/docs.json | 6 +++ docs/providers/google.md | 78 +++++++++++++++++++++++++++ docs/providers/index.md | 5 ++ docs/providers/modelstudio.md | 66 +++++++++++++++++++++++ docs/providers/perplexity-provider.md | 56 +++++++++++++++++++ docs/providers/volcengine.md | 74 +++++++++++++++++++++++++ 6 files changed, 285 insertions(+) create mode 100644 docs/providers/google.md create mode 100644 docs/providers/modelstudio.md create mode 100644 docs/providers/perplexity-provider.md create mode 100644 docs/providers/volcengine.md diff --git a/docs/docs.json b/docs/docs.json index 1d98a93c602..0b83537a7cd 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -1101,11 +1101,13 @@ "providers/claude-max-api-proxy", "providers/deepgram", "providers/github-copilot", + "providers/google", "providers/huggingface", "providers/kilocode", "providers/litellm", "providers/glm", "providers/minimax", + "providers/modelstudio", "providers/moonshot", "providers/mistral", "providers/nvidia", @@ -1114,13 +1116,17 @@ "providers/opencode-go", "providers/opencode", "providers/openrouter", + "providers/perplexity-provider", "providers/qianfan", "providers/qwen", + "providers/sglang", "providers/synthetic", "providers/together", "providers/vercel-ai-gateway", "providers/venice", "providers/vllm", + "providers/volcengine", + "providers/xai", "providers/xiaomi", "providers/zai" ] diff --git a/docs/providers/google.md b/docs/providers/google.md new file mode 100644 index 00000000000..569735db730 --- /dev/null +++ b/docs/providers/google.md @@ -0,0 +1,78 @@ +--- +title: "Google (Gemini)" +summary: "Google Gemini setup (API key + OAuth, image generation, media understanding, web search)" +read_when: + - You want to use Google Gemini models with OpenClaw + - You need the API key or OAuth auth flow +--- + +# Google (Gemini) + +The Google plugin provides access to Gemini models through Google AI Studio, plus +image generation, media understanding (image/audio/video), and web search via +Gemini Grounding. + +- Provider: `google` +- Auth: `GEMINI_API_KEY` or `GOOGLE_API_KEY` +- API: Google Gemini API +- Alternative provider: `google-gemini-cli` (OAuth) + +## Quick start + +1. Set the API key: + +```bash +openclaw onboard --auth-choice google-api-key +``` + +2. Set a default model: + +```json5 +{ + agents: { + defaults: { + model: { primary: "google/gemini-3.1-pro-preview" }, + }, + }, +} +``` + +## Non-interactive example + +```bash +openclaw onboard --non-interactive \ + --mode local \ + --auth-choice google-api-key \ + --gemini-api-key "$GEMINI_API_KEY" +``` + +## OAuth (Gemini CLI) + +An alternative provider `google-gemini-cli` uses PKCE OAuth instead of an API +key. This is an unofficial integration; some users report account +restrictions. Use at your own risk. + +Environment variables: + +- `OPENCLAW_GEMINI_OAUTH_CLIENT_ID` +- `OPENCLAW_GEMINI_OAUTH_CLIENT_SECRET` + +(Or the `GEMINI_CLI_*` variants.) + +## Capabilities + +| Capability | Supported | +| ---------------------- | ----------------- | +| Chat completions | Yes | +| Image generation | Yes | +| Image understanding | Yes | +| Audio transcription | Yes | +| Video understanding | Yes | +| Web search (Grounding) | Yes | +| Thinking/reasoning | Yes (Gemini 3.1+) | + +## Environment note + +If the Gateway runs as a daemon (launchd/systemd), make sure `GEMINI_API_KEY` +is available to that process (for example, in `~/.openclaw/.env` or via +`env.shellEnv`). diff --git a/docs/providers/index.md b/docs/providers/index.md index 7da77b34c5d..be2b5154f61 100644 --- a/docs/providers/index.md +++ b/docs/providers/index.md @@ -30,23 +30,28 @@ Looking for chat channel docs (WhatsApp/Telegram/Discord/Slack/Mattermost (plugi - [Anthropic (API + Claude Code CLI)](/providers/anthropic) - [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway) - [GLM models](/providers/glm) +- [Google (Gemini)](/providers/google) - [Hugging Face (Inference)](/providers/huggingface) - [Kilocode](/providers/kilocode) - [LiteLLM (unified gateway)](/providers/litellm) - [MiniMax](/providers/minimax) - [Mistral](/providers/mistral) +- [Model Studio (Alibaba Cloud)](/providers/modelstudio) - [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot) - [NVIDIA](/providers/nvidia) - [Ollama (cloud + local models)](/providers/ollama) - [OpenAI (API + Codex)](/providers/openai) - [OpenCode (Zen + Go)](/providers/opencode) - [OpenRouter](/providers/openrouter) +- [Perplexity (web search)](/providers/perplexity-provider) - [Qianfan](/providers/qianfan) - [Qwen (OAuth)](/providers/qwen) +- [SGLang (local models)](/providers/sglang) - [Together AI](/providers/together) - [Vercel AI Gateway](/providers/vercel-ai-gateway) - [Venice (Venice AI, privacy-focused)](/providers/venice) - [vLLM (local models)](/providers/vllm) +- [Volcengine (Doubao)](/providers/volcengine) - [xAI](/providers/xai) - [Xiaomi](/providers/xiaomi) - [Z.AI](/providers/zai) diff --git a/docs/providers/modelstudio.md b/docs/providers/modelstudio.md new file mode 100644 index 00000000000..65059322de6 --- /dev/null +++ b/docs/providers/modelstudio.md @@ -0,0 +1,66 @@ +--- +title: "Model Studio" +summary: "Alibaba Cloud Model Studio setup (Coding Plan, dual region endpoints)" +read_when: + - You want to use Alibaba Cloud Model Studio with OpenClaw + - You need the API key env var for Model Studio +--- + +# Model Studio (Alibaba Cloud) + +The Model Studio provider gives access to Alibaba Cloud Coding Plan models, +including Qwen and third-party models hosted on the platform. + +- Provider: `modelstudio` +- Auth: `MODELSTUDIO_API_KEY` +- API: OpenAI-compatible + +## Quick start + +1. Set the API key: + +```bash +openclaw onboard --auth-choice modelstudio-api-key +``` + +2. Set a default model: + +```json5 +{ + agents: { + defaults: { + model: { primary: "modelstudio/qwen3.5-plus" }, + }, + }, +} +``` + +## Region endpoints + +Model Studio has two endpoints based on region: + +| Region | Endpoint | +| ---------- | ------------------------------------ | +| China (CN) | `coding.dashscope.aliyuncs.com` | +| Global | `coding-intl.dashscope.aliyuncs.com` | + +The provider auto-selects based on the auth choice (`modelstudio-api-key` for +global, `modelstudio-api-key-cn` for China). You can override with a custom +`baseUrl` in config. + +## Available models + +- **qwen3.5-plus** (default) - Qwen 3.5 Plus +- **qwen3-max** - Qwen 3 Max +- **qwen3-coder** series - Qwen coding models +- **GLM-5**, **GLM-4.7** - GLM models via Alibaba +- **Kimi K2.5** - Moonshot AI via Alibaba +- **MiniMax-M2.5** - MiniMax via Alibaba + +Most models support image input. Context windows range from 200K to 1M tokens. + +## Environment note + +If the Gateway runs as a daemon (launchd/systemd), make sure +`MODELSTUDIO_API_KEY` is available to that process (for example, in +`~/.openclaw/.env` or via `env.shellEnv`). diff --git a/docs/providers/perplexity-provider.md b/docs/providers/perplexity-provider.md new file mode 100644 index 00000000000..c0945627e39 --- /dev/null +++ b/docs/providers/perplexity-provider.md @@ -0,0 +1,56 @@ +--- +title: "Perplexity (Provider)" +summary: "Perplexity web search provider setup (API key, search modes, filtering)" +read_when: + - You want to configure Perplexity as a web search provider + - You need the Perplexity API key or OpenRouter proxy setup +--- + +# Perplexity (Web Search Provider) + +The Perplexity plugin provides web search capabilities through the Perplexity +Search API or Perplexity Sonar via OpenRouter. + + +This page covers the Perplexity **provider** setup. For the Perplexity +**tool** (how the agent uses it), see [Perplexity tool](/perplexity). + + +- Type: web search provider (not a model provider) +- Auth: `PERPLEXITY_API_KEY` (direct) or `OPENROUTER_API_KEY` (via OpenRouter) +- Config path: `tools.web.search.perplexity.apiKey` + +## Quick start + +1. Set the API key: + +```bash +openclaw config set tools.web.search.perplexity.apiKey "pplx-xxxxxxxxxxxx" +``` + +2. The agent will automatically use Perplexity for web searches when configured. + +## Search modes + +The plugin auto-selects the transport based on API key prefix: + +| Key prefix | Transport | Features | +| ---------- | ---------------------------- | ------------------------------------------------ | +| `pplx-` | Native Perplexity Search API | Structured results, domain/language/date filters | +| `sk-or-` | OpenRouter (Sonar) | AI-synthesized answers with citations | + +## Native API filtering + +When using the native Perplexity API (`pplx-` key), searches support: + +- **Country**: 2-letter country code +- **Language**: ISO 639-1 language code +- **Date range**: day, week, month, year +- **Domain filters**: allowlist/denylist (max 20 domains) +- **Content budget**: `max_tokens`, `max_tokens_per_page` + +## Environment note + +If the Gateway runs as a daemon (launchd/systemd), make sure +`PERPLEXITY_API_KEY` is available to that process (for example, in +`~/.openclaw/.env` or via `env.shellEnv`). diff --git a/docs/providers/volcengine.md b/docs/providers/volcengine.md new file mode 100644 index 00000000000..75ad2577dec --- /dev/null +++ b/docs/providers/volcengine.md @@ -0,0 +1,74 @@ +--- +title: "Volcengine (Doubao)" +summary: "Volcano Engine setup (Doubao models, general + coding endpoints)" +read_when: + - You want to use Volcano Engine or Doubao models with OpenClaw + - You need the Volcengine API key setup +--- + +# Volcengine (Doubao) + +The Volcengine provider gives access to Doubao models and third-party models +hosted on Volcano Engine, with separate endpoints for general and coding +workloads. + +- Providers: `volcengine` (general) + `volcengine-plan` (coding) +- Auth: `VOLCANO_ENGINE_API_KEY` +- API: OpenAI-compatible + +## Quick start + +1. Set the API key: + +```bash +openclaw onboard --auth-choice volcengine-api-key +``` + +2. Set a default model: + +```json5 +{ + agents: { + defaults: { + model: { primary: "volcengine-plan/ark-code-latest" }, + }, + }, +} +``` + +## Non-interactive example + +```bash +openclaw onboard --non-interactive \ + --mode local \ + --auth-choice volcengine-api-key \ + --volcengine-api-key "$VOLCANO_ENGINE_API_KEY" +``` + +## Providers and endpoints + +| Provider | Endpoint | Use case | +| ----------------- | ----------------------------------------- | -------------- | +| `volcengine` | `ark.cn-beijing.volces.com/api/v3` | General models | +| `volcengine-plan` | `ark.cn-beijing.volces.com/api/coding/v3` | Coding models | + +Both providers are configured from a single API key. Setup registers both +automatically. + +## Available models + +- **doubao-seed-1-8** - Doubao Seed 1.8 (general, default) +- **doubao-seed-code-preview** - Doubao coding model +- **ark-code-latest** - Coding plan default +- **Kimi K2.5** - Moonshot AI via Volcano Engine +- **GLM-4.7** - GLM via Volcano Engine +- **DeepSeek V3.2** - DeepSeek via Volcano Engine + +Most models support text + image input. Context windows range from 128K to 256K +tokens. + +## Environment note + +If the Gateway runs as a daemon (launchd/systemd), make sure +`VOLCANO_ENGINE_API_KEY` is available to that process (for example, in +`~/.openclaw/.env` or via `env.shellEnv`).