跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

模型故障转移

认证配置轮换、冷却时间,以及它们如何与回退交互。

模型提供商

快速的提供商概览和示例。

Agent Runtimes

Pi、Codex 和其他 Agent loop 运行时。

配置参考

模型配置键。
模型引用会选择提供商和模型。它们通常不会选择底层 Agent 运行时。OpenAI Agent 引用是主要例外:openai/gpt-5.5 默认通过官方 OpenAI provider 上的 Codex 应用服务器运行时运行。显式运行时覆盖应属于提供商/模型策略,而不是整个智能体或会话。在 Codex 运行时模式下,openai/gpt-* 引用并不意味着 API 密钥计费;认证可以来自 Codex 账户或 openai-codex 认证配置。参见 Agent Runtimes

模型选择的工作方式

OpenClaw 按以下顺序选择模型:
1

主模型

agents.defaults.model.primary(或 agents.defaults.model)。
2

回退

agents.defaults.model.fallbacks(按顺序)。
3

提供商认证故障转移

在移到下一个模型之前,认证故障转移会先在提供商内部发生。
  • agents.defaults.models 是 OpenClaw 可使用模型(以及别名)的允许列表/目录。使用 provider/* 条目限制可见提供商,同时保持提供商设备发现动态。
  • agents.defaults.imageModel 仅在主模型不能接受图像时使用。
  • agents.defaults.pdfModelpdf 工具使用。如果省略,该工具会回退到 agents.defaults.imageModel,然后回退到解析后的会话/默认模型。
  • agents.defaults.imageGenerationModel 由共享的图像生成能力使用。如果省略,image_generate 仍可推断一个有认证支持的提供商默认值。它会先尝试当前默认提供商,然后按提供商 ID 顺序尝试其余已注册的图像生成提供商。如果你设置了特定提供商/模型,也要配置该提供商的认证/API 密钥。
  • agents.defaults.musicGenerationModel 由共享的音乐生成能力使用。如果省略,music_generate 仍可推断一个有认证支持的提供商默认值。它会先尝试当前默认提供商,然后按提供商 ID 顺序尝试其余已注册的音乐生成提供商。如果你设置了特定提供商/模型,也要配置该提供商的认证/API 密钥。
  • agents.defaults.videoGenerationModel 由共享的视频生成能力使用。如果省略,video_generate 仍可推断一个有认证支持的提供商默认值。它会先尝试当前默认提供商,然后按提供商 ID 顺序尝试其余已注册的视频生成提供商。如果你设置了特定提供商/模型,也要配置该提供商的认证/API 密钥。
  • 每智能体默认值可以通过 agents.list[].model 加绑定来覆盖 agents.defaults.model(参见 多 Agent 路由)。

选择来源和回退行为

同一个 provider/model 可能根据其来源表示不同含义:
  • 已配置的默认值(agents.defaults.model.primary 和智能体专用主模型)是正常起点,并使用 agents.defaults.model.fallbacks
  • 自动回退选择是临时恢复状态。它们会与 modelOverrideSource: "auto" 一起存储,因此后续轮次可以继续使用回退链,而不必先探测已知不可用的主模型。
  • 用户会话选择是精确的。/model、模型选择器、session_status(model=...)sessions.patch 会存储 modelOverrideSource: "user";如果所选提供商/模型不可达,OpenClaw 会明确失败,而不是落到另一个已配置模型。
  • Cron --model / payload model 是每个作业的主模型。除非作业提供显式 payload fallbacks,否则它仍会使用已配置的回退(严格 cron 运行可使用 fallbacks: [])。
  • CLI 默认模型和允许列表选择器会尊重 models.mode: "replace",列出显式的 models.providers.*.models,而不是加载完整的内置目录。
  • Control UI 模型选择器会向 Gateway 网关请求其已配置的模型视图:存在 agents.defaults.models 时使用它,包括提供商级 provider/* 条目;否则使用显式 models.providers.*.models 加上具有可用认证的提供商。完整内置目录仅保留给显式浏览视图,例如带 view: "all"models.listopenclaw models list --all

快速模型策略

  • 将你的主模型设置为你可用的最强最新一代模型。
  • 对成本/延迟敏感任务和低风险聊天使用回退。
  • 对启用工具的智能体或不受信任的输入,避免使用较旧/较弱的模型层级。

新手引导(推荐)

如果你不想手动编辑配置,请运行新手引导:
openclaw onboard
它可以为常见提供商设置模型 + 认证,包括 OpenAI Code (Codex) subscription(OAuth)和 Anthropic(API 密钥或 Claude CLI)。

配置键(概览)

  • agents.defaults.model.primaryagents.defaults.model.fallbacks
  • agents.defaults.imageModel.primaryagents.defaults.imageModel.fallbacks
  • agents.defaults.pdfModel.primaryagents.defaults.pdfModel.fallbacks
  • agents.defaults.imageGenerationModel.primaryagents.defaults.imageGenerationModel.fallbacks
  • agents.defaults.videoGenerationModel.primaryagents.defaults.videoGenerationModel.fallbacks
  • agents.defaults.models(允许列表 + 别名 + 提供商参数 + provider/* 动态提供商条目)
  • models.providers(写入 models.json 的自定义提供商)
模型引用会规范化为小写。像 z.ai/* 这样的提供商别名会规范化为 zai/*提供商配置示例(包括 OpenCode)位于 OpenCode

安全编辑允许列表

手动更新 agents.defaults.models 时使用追加写入:
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --merge
openclaw config set 会保护模型/提供商映射,防止意外覆盖。当普通对象赋值给 agents.defaults.modelsmodels.providersmodels.providers.<id>.models 且会移除现有条目时,该操作会被拒绝。使用 --merge 进行追加更改;仅当提供的值应成为完整目标值时才使用 --replace交互式提供商设置和 openclaw configure --section model 也会将提供商范围内的选择合并到现有允许列表中,因此添加 Codex、Ollama 或其他提供商不会删除无关的模型条目。重新应用提供商认证时,configure 会保留现有 agents.defaults.model.primary。显式默认值设置命令,例如 openclaw models auth login --provider <id> --set-defaultopenclaw models set <model>,仍会替换 agents.defaults.model.primary

“Model is not allowed”(以及为什么回复会停止)

如果设置了 agents.defaults.models,它会成为 /model 和会话覆盖的允许列表。当用户选择不在该允许列表中的模型时,OpenClaw 会返回:
Model "provider/model" is not allowed. Use /models to list providers, or /models <provider> to list models.
Add it with: openclaw config set agents.defaults.models '{"provider/model":{}}' --strict-json --merge
这发生在正常回复生成之前,因此这条消息可能让人觉得它“没有响应”。修复方式是:
  • 将该模型添加到 agents.defaults.models,或
  • 清空允许列表(移除 agents.defaults.models),或
  • /model list 中选择一个模型。
当被拒绝的命令包含运行时覆盖,例如 /model openai/gpt-5.5 --runtime codex,请先修复允许列表,然后重试同一个 /model ... --runtime ... 命令。对于原生 Codex 执行,所选模型仍是 openai/gpt-5.5codex 运行时会选择 harness,并单独使用 Codex 认证。 对于本地/GGUF 模型,请在允许列表中存储完整的提供商前缀引用, 例如 ollama/gemma4:26blmstudio/Gemma4-26b-a4-it-gguf,或 openclaw models list --provider <provider> 显示的确切提供商/模型。 当允许列表处于活动状态时,仅使用本地文件名或显示名称是不够的。 如果你想限制提供商,而不想手动列出每个模型,请向 agents.defaults.models 添加 provider/* 条目:
{
  agents: {
    defaults: {
      models: {
        "openai-codex/*": {},
        "vllm/*": {},
      },
    },
  },
}
使用该策略时,/model/models 和模型选择器只会显示这些提供商的已发现 目录。所选提供商的新模型可以在不编辑允许列表的情况下出现。当你需要来自另一个提供商的某个特定模型时,可以将确切的 provider/model 条目与 provider/* 条目混用。 允许列表示例配置:
{
  agents: {
    defaults: {
      model: { primary: "anthropic/claude-sonnet-4-6" },
      models: {
        "anthropic/claude-sonnet-4-6": { alias: "Sonnet" },
        "anthropic/claude-opus-4-6": { alias: "Opus" },
      },
    },
  },
}

在聊天中切换模型(/model

你可以为当前会话切换模型,而无需重启:
/model
/model list
/model 3
/model openai/gpt-5.4
/model status
  • /model(以及 /model list)是紧凑的编号选择器(模型家族 + 可用提供商)。
  • 在 Discord 上,/model/models 会打开带提供商和模型下拉菜单以及提交步骤的交互式选择器。
  • 在 Telegram 上,/models 选择器的选择作用域为会话;它们不会更改 openclaw.json 中智能体的持久默认值。
  • /models add 已弃用,现在会返回弃用消息,而不是从聊天中注册模型。
  • /model <#> 会从该选择器中选择。
  • /model 会立即持久化新的会话选择。
  • 如果智能体处于空闲状态,下一次运行会立刻使用新模型。
  • 如果已有运行处于活动状态,OpenClaw 会将实时切换标记为待处理,并只会在干净的重试点重启到新模型。
  • 如果工具活动或回复输出已经开始,待处理的切换可能会一直排队,直到后续重试机会或下一次用户轮次。
  • 用户选择的 /model 引用对该会话是严格的:如果所选提供商/模型不可达,回复会明确失败,而不是从 agents.defaults.model.fallbacks 静默回答。这不同于已配置的默认值和 cron 作业主模型,它们仍可使用回退链。
  • /model status 是详细视图(认证候选项,以及在配置后提供商端点 baseUrl + api 模式)。
  • 模型引用通过按第一个 / 拆分来解析。在输入 /model <ref> 时使用 provider/model
  • 如果模型 ID 本身包含 /(OpenRouter 风格),你必须包含提供商前缀(示例:/model openrouter/moonshotai/kimi-k2)。
  • 如果你省略提供商,OpenClaw 会按以下顺序解析输入:
    1. 别名匹配
    2. 针对该精确无前缀模型 id 的唯一已配置提供商匹配
    3. 已弃用的回退到已配置的默认提供商 — 如果该提供商不再公开已配置的默认模型,OpenClaw 会改为回退到第一个已配置的提供商/模型,以避免暴露过时的已移除提供商默认值。
完整命令行为/配置:斜杠命令

CLI 命令

openclaw models list
openclaw models status
openclaw models set <provider/model>
openclaw models set-image <provider/model>

openclaw models aliases list
openclaw models aliases add <alias> <provider/model>
openclaw models aliases remove <alias>

openclaw models fallbacks list
openclaw models fallbacks add <provider/model>
openclaw models fallbacks remove <provider/model>
openclaw models fallbacks clear

openclaw models image-fallbacks list
openclaw models image-fallbacks add <provider/model>
openclaw models image-fallbacks remove <provider/model>
openclaw models image-fallbacks clear
openclaw models(无子命令)是 models status 的快捷方式。

models list

默认显示已配置/认证可用的模型。实用标志:
--all
boolean
完整目录。包含在配置认证之前由内置提供商拥有的静态目录行,因此仅发现视图可以显示在你添加匹配的提供商凭证之前不可用的模型。
--local
boolean
仅本地提供商。
--provider <id>
string
按提供商 id 过滤,例如 moonshot。不接受交互式选择器中的显示标签。
--plain
boolean
每行一个模型。
--json
boolean
机器可读输出。

models status

显示已解析的主模型、回退、图像模型,以及已配置提供商的认证概览。它还会为认证存储中找到的配置文件显示 OAuth 过期状态(默认在 24 小时内发出警告)。--plain 只打印已解析的主模型。
  • OAuth 状态始终显示(并包含在 --json 输出中)。如果已配置的提供商没有凭证,models status 会打印一个缺失认证部分。
  • JSON 包含 auth.oauth(警告窗口 + 配置文件)和 auth.providers(每个提供商的有效认证,包括环境变量支持的凭证)。auth.oauth 仅表示认证存储配置文件健康状态;仅环境变量的提供商不会出现在其中。
  • --check 用于自动化(缺失/过期时退出 1,即将过期时退出 2)。
  • --probe 用于实时认证检查;探测行可以来自认证配置文件、环境变量凭证或 models.json
  • 如果显式 auth.order.<provider> 省略了某个已存储配置文件,探测会报告 excluded_by_auth_order,而不是尝试它。如果认证存在但无法为该提供商解析出可探测模型,探测会报告 status: no_model
认证选择取决于提供商/账户。对于常驻 Gateway 网关主机,API 密钥通常最可预测;也支持复用 Claude CLI 和现有 Anthropic OAuth/token 配置文件。
示例(Claude CLI):
claude auth login
openclaw models status

扫描(OpenRouter 免费模型)

openclaw models scan 会检查 OpenRouter 的免费模型目录,并且可以选择性地探测模型的工具和图像支持。
--no-probe
boolean
跳过实时探测(仅元数据)。
--min-params <b>
number
最小参数规模(十亿)。
--max-age-days <days>
number
跳过较旧模型。
--provider <name>
string
提供商前缀过滤器。
--max-candidates <n>
number
回退列表大小。
--set-default
boolean
agents.defaults.model.primary 设置为第一个选择项。
--set-image
boolean
agents.defaults.imageModel.primary 设置为第一个图像选择项。
OpenRouter /models 目录是公开的,因此仅元数据扫描可以在没有密钥的情况下列出免费候选项。探测和推理仍然需要 OpenRouter API 密钥(来自认证配置文件或 OPENROUTER_API_KEY)。如果没有可用密钥,openclaw models scan 会回退到仅元数据输出,并保持配置不变。使用 --no-probe 可显式请求仅元数据模式。
扫描结果按以下顺序排名:
  1. 图像支持
  2. 工具延迟
  3. 上下文大小
  4. 参数数量
输入:
  • OpenRouter /models 列表(过滤 :free
  • 实时探测需要来自认证配置文件或 OPENROUTER_API_KEY 的 OpenRouter API 密钥(见环境变量
  • 可选过滤器:--max-age-days--min-params--provider--max-candidates
  • 请求/探测控制:--timeout--concurrency
当实时探测在 TTY 中运行时,你可以交互式选择回退。在非交互模式中,传递 --yes 接受默认值。仅元数据结果仅供参考;--set-default--set-image 需要实时探测,这样 OpenClaw 不会配置一个无法使用的无密钥 OpenRouter 模型。

Models 注册表(models.json

models.providers 中的自定义提供商会写入智能体目录下的 models.json(默认 ~/.openclaw/agents/<agentId>/agent/models.json)。默认会合并此文件,除非 models.mode 设置为 replace
匹配提供商 ID 的合并模式优先级:
  • 智能体 models.json 中已存在的非空 baseUrl 优先。
  • 智能体 models.json 中的非空 apiKey 仅在该提供商不由当前配置/认证配置文件上下文中的 SecretRef 管理时优先。
  • 由 SecretRef 管理的提供商 apiKey 值会从源标记刷新(环境变量 ref 使用 ENV_VAR_NAME,文件/exec ref 使用 secretref-managed),而不是持久化已解析的密钥。
  • 由 SecretRef 管理的提供商 header 值会从源标记刷新(环境变量 ref 使用 secretref-env:ENV_VAR_NAME,文件/exec ref 使用 secretref-managed)。
  • 空或缺失的智能体 apiKey/baseUrl 会回退到配置 models.providers
  • 其他提供商字段会从配置和规范化目录数据刷新。
标记持久化以源为权威:OpenClaw 会从活动源配置快照(解析前)写入标记,而不是从已解析的运行时密钥值写入。这适用于 OpenClaw 重新生成 models.json 的任何时候,包括 openclaw agent 之类由命令驱动的路径。

相关