docs: add provider hub and model provider pages

This commit is contained in:
Peter Steinberger
2026-01-11 02:27:30 +01:00
parent 2d74119a08
commit 340d1c64b4
8 changed files with 300 additions and 0 deletions

View File

@@ -0,0 +1,62 @@
---
summary: "Use Anthropic Claude via API keys or Claude CLI auth in Clawdbot"
read_when:
- You want to use Anthropic models in Clawdbot
- You want setup-token or Claude CLI auth instead of API keys
---
# Anthropic (Claude)
Anthropic builds the **Claude** model family and provides access via an API.
In Clawdbot you can authenticate with an API key or reuse **Claude Code / Claude CLI**
credentials (setup-token or OAuth).
## Option A: Anthropic API key
**Best for:** standard API access and usage-based billing.
Create your API key in the Anthropic Console.
### CLI setup
```bash
clawdbot onboard
# choose: Anthropic API key
# or non-interactive
clawdbot onboard --anthropic-api-key "$ANTHROPIC_API_KEY"
```
### Config snippet
```json5
{
env: { ANTHROPIC_API_KEY: "sk-ant-..." },
agents: { defaults: { model: { primary: "anthropic/claude-opus-4-5" } } }
}
```
## Option B: Claude CLI (setup-token or OAuth)
**Best for:** using your Claude subscription or existing Claude CLI login.
### CLI setup
```bash
# Run setup-token on the gateway host (wizard can run it for you)
clawdbot onboard --auth-choice setup-token
# Reuse Claude CLI OAuth credentials if already logged in
clawdbot onboard --auth-choice claude-cli
```
### Config snippet
```json5
{
agents: { defaults: { model: { primary: "anthropic/claude-opus-4-5" } } }
}
```
## Notes
- The wizard can run `claude setup-token` on the gateway host and store the token.
- Auth details + reuse rules are in [/concepts/oauth](/concepts/oauth).

31
docs/providers/glm.md Normal file
View File

@@ -0,0 +1,31 @@
---
summary: "GLM model family overview + how to use it in Clawdbot"
read_when:
- You want GLM models in Clawdbot
- You need the model naming convention and setup
---
# GLM models
GLM is a **model family** (not a company) available through the Z.AI platform. In Clawdbot, GLM
models are accessed via the `zai` provider and model IDs like `zai/glm-4.7`.
## CLI setup
```bash
clawdbot onboard --auth-choice zai-api-key
```
## Config snippet
```json5
{
env: { ZAI_API_KEY: "sk-..." },
agents: { defaults: { model: { primary: "zai/glm-4.7" } } }
}
```
## Notes
- GLM versions and availability can change; check Z.AI's docs for the latest.
- Example model IDs include `glm-4.7` and `glm-4.6`.
- For provider details, see [/providers/zai](/providers/zai).

40
docs/providers/index.md Normal file
View File

@@ -0,0 +1,40 @@
---
summary: "All supported providers (models + messaging) in one place"
read_when:
- You want a single hub for every provider we document
- You want model providers vs chat providers split clearly
---
# Providers hub
This hub covers **model providers** (LLMs) and **messaging/chat providers** (WhatsApp, Telegram, etc).
For model selection rules, see [/concepts/models](/concepts/models). For the full provider catalog, see
[/concepts/model-providers](/concepts/model-providers).
## Model providers
- [OpenAI (API + Codex)](/providers/openai)
- [Anthropic (API + Claude CLI)](/providers/anthropic)
- [OpenRouter](/providers/openrouter)
- [OpenCode Zen](/providers/opencode)
- [Z.AI](/providers/zai)
- [GLM models](/providers/glm)
Full list (xAI, Groq, Mistral, etc.): [/concepts/model-providers](/concepts/model-providers)
## Messaging + chat providers
- [WhatsApp](/providers/whatsapp)
- [Telegram](/providers/telegram)
- [Telegram (grammY notes)](/providers/grammy)
- [Slack](/providers/slack)
- [Discord](/providers/discord)
- [Signal](/providers/signal)
- [iMessage](/providers/imessage)
- [Location parsing](/providers/location)
- [Provider troubleshooting](/providers/troubleshooting)
## Ingress + web
- [WebChat](/web/webchat)
- [Webhooks](/automation/webhook)
- [Gmail Pub/Sub](/automation/gmail-pubsub)

63
docs/providers/openai.md Normal file
View File

@@ -0,0 +1,63 @@
---
summary: "Use OpenAI via API keys or Codex subscription in Clawdbot"
read_when:
- You want to use OpenAI models in Clawdbot
- You want Codex subscription auth instead of API keys
---
# OpenAI
OpenAI provides developer APIs for GPT models. Codex supports **ChatGPT sign-in** for subscription
access or **API key** sign-in for usage-based access. The Codex CLI caches login details in
`~/.codex/auth.json` (or your OS credential store), which Clawdbot can reuse.
## Option A: OpenAI API key (OpenAI Platform)
**Best for:** direct API access and usage-based billing.
Get your API key from the OpenAI dashboard.
### CLI setup
```bash
clawdbot onboard --auth-choice openai-api-key
# or non-interactive
clawdbot onboard --openai-api-key "$OPENAI_API_KEY"
```
### Config snippet
```json5
{
env: { OPENAI_API_KEY: "sk-..." },
agents: { defaults: { model: { primary: "openai/gpt-5.2" } } }
}
```
## Option B: OpenAI Code (Codex) subscription
**Best for:** using ChatGPT/Codex subscription access instead of an API key.
Codex cloud requires ChatGPT sign-in, while the Codex CLI supports ChatGPT or API key sign-in.
Clawdbot can reuse your **Codex CLI** login (`~/.codex/auth.json`) or run the OAuth flow.
### CLI setup
```bash
# Reuse existing Codex CLI login
clawdbot onboard --auth-choice codex-cli
# Or run Codex OAuth in the wizard
clawdbot onboard --auth-choice openai-codex
```
### Config snippet
```json5
{
agents: { defaults: { model: { primary: "openai-codex/gpt-5.2" } } }
}
```
## Notes
- Model refs always use `provider/model` (see [/concepts/models](/concepts/models)).
- Auth details + reuse rules are in [/concepts/oauth](/concepts/oauth).

View File

@@ -0,0 +1,34 @@
---
summary: "Use OpenCode Zen (curated models) with Clawdbot"
read_when:
- You want OpenCode Zen for model access
- You want a curated list of coding-friendly models
---
# OpenCode Zen
OpenCode Zen is a **curated list of models** recommended by the OpenCode team for coding agents.
It is an optional, hosted model access path that uses an API key and the `opencode` provider.
Zen is currently in beta.
## CLI setup
```bash
clawdbot onboard --auth-choice opencode-zen
# or non-interactive
clawdbot onboard --opencode-zen-api-key "$OPENCODE_API_KEY"
```
## Config snippet
```json5
{
env: { OPENCODE_API_KEY: "sk-..." },
agents: { defaults: { model: { primary: "opencode/claude-opus-4-5" } } }
}
```
## Notes
- `OPENCODE_ZEN_API_KEY` is also supported.
- You sign in to Zen, add billing details, and copy your API key.
- OpenCode Zen bills per request; check the OpenCode dashboard for details.

View File

@@ -0,0 +1,35 @@
---
summary: "Use OpenRouter's unified API to access many models in Clawdbot"
read_when:
- You want a single API key for many LLMs
- You want to run models via OpenRouter in Clawdbot
---
# OpenRouter
OpenRouter provides a **unified API** that routes requests to many models behind a single
endpoint and API key. It is OpenAI-compatible, so most OpenAI SDKs work by switching the base URL.
## CLI setup
```bash
clawdbot onboard --auth-choice apiKey --token-provider openrouter --token "$OPENROUTER_API_KEY"
```
## Config snippet
```json5
{
env: { OPENROUTER_API_KEY: "sk-or-..." },
agents: {
defaults: {
model: { primary: "openrouter/anthropic/claude-sonnet-4-5" }
}
}
}
```
## Notes
- Model refs are `openrouter/<provider>/<model>`.
- For more model/provider options, see [/concepts/model-providers](/concepts/model-providers).
- OpenRouter uses a Bearer token with your API key under the hood.

34
docs/providers/zai.md Normal file
View File

@@ -0,0 +1,34 @@
---
summary: "Use Z.AI (GLM models) with Clawdbot"
read_when:
- You want Z.AI / GLM models in Clawdbot
- You need a simple ZAI_API_KEY setup
---
# Z.AI
Z.AI is the API platform for **GLM** models. It provides REST APIs for GLM and uses API keys
for authentication. Create your API key in the Z.AI console. Clawdbot uses the `zai` provider
with a Z.AI API key.
## CLI setup
```bash
clawdbot onboard --auth-choice zai-api-key
# or non-interactive
clawdbot onboard --zai-api-key "$ZAI_API_KEY"
```
## Config snippet
```json5
{
env: { ZAI_API_KEY: "sk-..." },
agents: { defaults: { model: { primary: "zai/glm-4.7" } } }
}
```
## Notes
- GLM models are available as `zai/<model>` (example: `zai/glm-4.7`).
- See [/providers/glm](/providers/glm) for the model family overview.
- Z.AI uses Bearer auth with your API key.

View File

@@ -58,6 +58,7 @@ Use these hubs to discover every page, including deep dives and reference docs t
## Providers + ingress
- [Model providers hub](/providers)
- [WhatsApp](/providers/whatsapp)
- [Telegram](/providers/telegram)
- [Telegram (grammY notes)](/providers/grammy)