Files
clawdbot/docs/gateway/authentication.md
2026-01-12 06:38:16 +00:00

4.5 KiB
Raw Blame History

summary, read_when
summary read_when
Model authentication: OAuth, API keys, and Claude Code token reuse
Debugging model auth or OAuth expiry
Documenting authentication or credential storage

Authentication

Clawdbot supports OAuth and API keys for model providers. For Anthropic accounts, we recommend using an API key. Clawdbot can also reuse Claude Code credentials, including the longlived token created by claude setup-token.

See /concepts/oauth for the full OAuth flow and storage layout.

If youre using Anthropic directly, use an API key.

  1. Create an API key in the Anthropic Console.
  2. Put it on the gateway host (the machine running clawdbot gateway).
export ANTHROPIC_API_KEY="..."
clawdbot models status
  1. If the Gateway runs under systemd/launchd, prefer putting the key in ~/.clawdbot/.env so the daemon can read it:
cat >> ~/.clawdbot/.env <<'EOF'
ANTHROPIC_API_KEY=...
EOF

Then restart the daemon (or restart your Gateway process) and re-check:

clawdbot models status
clawdbot doctor

If youd rather not manage env vars yourself, the onboarding wizard can store API keys for daemon use: clawdbot onboard.

See /start/faq for details on env inheritance (env.shellEnv, ~/.clawdbot/.env, systemd/launchd).

Anthropic: Claude CLI setup-token (supported)

For Anthropic, the recommended path is an API key. If youre already using Claude Code, the Claude CLI setup-token is also supported. Run it on the gateway host:

claude setup-token

Then verify and sync into Clawdbot:

clawdbot models status
clawdbot doctor

This should create (or refresh) an auth profile like anthropic:claude-cli in the agent auth store.

If you see an Anthropic error like:

This credential is only authorized for use with Claude Code and cannot be used for other API requests.

…use an Anthropic API key instead.

Alternative: run the wrapper (also updates Clawdbot config):

clawdbot models auth setup-token --provider anthropic

Manual token entry (any provider; writes auth-profiles.json + updates config):

clawdbot models auth paste-token --provider anthropic
clawdbot models auth paste-token --provider openrouter

Automation-friendly check (exit 1 when expired/missing, 2 when expiring):

clawdbot models status --check

Optional ops scripts (systemd/Termux) are documented here: /automation/auth-monitoring

clawdbot models status loads Claude Code credentials into Clawdbots auth-profiles.json and shows expiry (warns within 24h by default). clawdbot doctor also performs the sync when it runs.

claude setup-token requires an interactive TTY.

Checking model auth status

clawdbot models status
clawdbot doctor

Controlling which credential is used

Per-session (chat command)

Use /model <alias-or-id>@<profileId> to pin a specific provider credential for the current session (example profile ids: anthropic:claude-cli, anthropic:default).

Use /model (or /model list) for a compact picker; use /model status for the full view (candidates + next auth profile, plus provider endpoint details when configured).

Per-agent (CLI override)

Set an explicit auth profile order override for an agent (stored in that agents auth-profiles.json):

clawdbot models auth order get --provider anthropic
clawdbot models auth order set --provider anthropic anthropic:claude-cli
clawdbot models auth order clear --provider anthropic

Use --agent <id> to target a specific agent; omit it to use the configured default agent.

How sync works

  1. Claude Code stores credentials in ~/.claude/.credentials.json (or Keychain on macOS).
  2. Clawdbot syncs those into ~/.clawdbot/agents/<agentId>/agent/auth-profiles.json when the auth store is loaded.
  3. Refreshable OAuth profiles can be refreshed automatically on use. Static token profiles (including Claude CLI setup-token) are not refreshable by Clawdbot.

Troubleshooting

“No credentials found”

If the Anthropic token profile is missing, run claude setup-token on the gateway host, then re-check:

clawdbot models status

Token expiring/expired

Run clawdbot models status to confirm which profile is expiring. If the profile is anthropic:claude-cli, rerun claude setup-token.

Requirements

  • Claude Max or Pro subscription (for claude setup-token)
  • Claude Code CLI installed (claude command available)