Perplexity Search API

OpenClaw 支持将 Perplexity Search API 用作 web_search 提供商。它返回结构化结果，包含 title、url 和 snippet 字段。

为了兼容旧配置，OpenClaw 也支持 Perplexity Sonar/OpenRouter 的传统用法。如果你使用 OPENROUTER_API_KEY、在 tools.web.search.perplexity.apiKey 中填入 sk-or-... 开头的密钥，或设置了 tools.web.search.perplexity.baseUrl / model，提供商会切换到 chat-completions 路径，返回带引用的 AI 合成回答，而不是结构化搜索结果。

获取 Perplexity API 密钥

在 https://www.perplexity.ai/settings/api 创建 Perplexity 账号
在控制台中生成 API 密钥
将密钥写入配置文件，或在 Gateway 环境中设置 PERPLEXITY_API_KEY

OpenRouter 兼容

如果你之前用的是 OpenRouter 接入 Perplexity Sonar，保持 provider: "perplexity" 不变，在 Gateway 环境中设置 OPENROUTER_API_KEY，或在 tools.web.search.perplexity.apiKey 中填入 sk-or-... 密钥即可。

可选的旧版配置项：

tools.web.search.perplexity.baseUrl
tools.web.search.perplexity.model

配置示例

原生 Perplexity Search API

{
  tools: {
    web: {
      search: {
        provider: "perplexity",
        perplexity: {
          apiKey: "pplx-...",
        },
      },
    },
  },
}

OpenRouter / Sonar 兼容模式

{
  tools: {
    web: {
      search: {
        provider: "perplexity",
        perplexity: {
          apiKey: "<openrouter-api-key>",
          baseUrl: "https://openrouter.ai/api/v1",
          model: "perplexity/sonar-pro",
        },
      },
    },
  },
}

密钥配置方式

通过配置文件： 运行 openclaw configure --section web，密钥会存储在 ~/.openclaw/openclaw.json 的 tools.web.search.perplexity.apiKey 中。该字段也接受 SecretRef 对象。

通过环境变量： 在 Gateway 进程环境中设置 PERPLEXITY_API_KEY 或 OPENROUTER_API_KEY。对于 Gateway 安装，放在 ~/.openclaw/.env 中（或你的服务环境中）。详见环境变量。

如果配置了 provider: "perplexity" 但 Perplexity 密钥的 SecretRef 无法解析且没有环境变量兜底，启动/重载会立即报错。

工具参数

以下参数适用于原生 Perplexity Search API 路径。

参数	说明
`query`	搜索关键词（必填）
`count`	返回结果数量（1-10，默认 5）
`country`	两位 ISO 国家代码（如 “US”、“DE”）
`language`	ISO 639-1 语言代码（如 “en”、“de”、“fr”）
`freshness`	时间过滤：`day`（24 小时）、`week`、`month`、`year`
`date_after`	仅返回此日期之后发布的结果（YYYY-MM-DD）
`date_before`	仅返回此日期之前发布的结果（YYYY-MM-DD）
`domain_filter`	域名白名单/黑名单数组（最多 20 个）
`max_tokens`	内容总 token 预算（默认 25000，上限 1000000）
`max_tokens_per_page`	每页 token 上限（默认 2048）

对于旧版 Sonar/OpenRouter 兼容路径，仅支持 query 和 freshness。Search API 专有的过滤参数如 country、language、date_after、date_before、domain_filter、max_tokens 和 max_tokens_per_page 会返回明确的错误。

示例：

// 按国家和语言搜索
await web_search({
  query: "renewable energy",
  country: "DE",
  language: "de",
});

// 最近结果（过去一周）
await web_search({
  query: "AI news",
  freshness: "week",
});

// 按日期范围搜索
await web_search({
  query: "AI developments",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

// 域名过滤（白名单）
await web_search({
  query: "climate research",
  domain_filter: ["nature.com", "science.org", ".edu"],
});

// 域名过滤（黑名单，用 - 前缀）
await web_search({
  query: "product reviews",
  domain_filter: ["-reddit.com", "-pinterest.com"],
});

// 提取更多内容
await web_search({
  query: "detailed AI research",
  max_tokens: 50000,
  max_tokens_per_page: 4096,
});

域名过滤规则

每次请求最多 20 个域名
同一请求中不能混用白名单和黑名单
黑名单条目用 - 前缀标记（如 ["-reddit.com"]）

注意事项

Perplexity Search API 返回结构化网页搜索结果（title、url、snippet）
使用 OpenRouter 或显式设置 baseUrl / model 会让 Perplexity 切回 Sonar chat completions 模式，以保持兼容
结果默认缓存 15 分钟（可通过 cacheTtlMinutes 调整）

完整的 web_search 配置详见 Web 工具。更多细节参阅 Perplexity Search API 文档。