Perplexity Search API

OpenClaw 支持将 Perplexity Search API 作为 web_search Provider。它返回包含 title、url 和 snippet 字段的结构化结果。

为了兼容性，OpenClaw 也支持旧版 Perplexity Sonar/OpenRouter 设置。如果你使用 OPENROUTER_API_KEY，在 plugins.entries.perplexity.config.webSearch.apiKey 中填入 sk-or-... 格式的 key，或者设置了 plugins.entries.perplexity.config.webSearch.baseUrl / model，Provider 会切换到 chat-completions 路径，返回带引用的 AI 合成答案，而不是结构化的 Search API 结果。

获取 Perplexity API Key

在 perplexity.ai/settings/api 创建 Perplexity 账号
在控制台生成 API Key
将 Key 存入配置，或在 Gateway 环境中设置 PERPLEXITY_API_KEY。

OpenRouter 兼容性

如果你之前已经在使用 OpenRouter 搭配 Perplexity Sonar，保持 provider: "perplexity" 不变，在 Gateway 环境中设置 OPENROUTER_API_KEY，或在 plugins.entries.perplexity.config.webSearch.apiKey 中存入 sk-or-... Key 即可。

可选兼容性控制：

plugins.entries.perplexity.config.webSearch.baseUrl
plugins.entries.perplexity.config.webSearch.model

配置示例

原生 Perplexity Search API

json5

{
  plugins: {
    entries: {
      perplexity: {
        config: {
          webSearch: {
            apiKey: "pplx-...",
          },
        },
      },
    },
  },
  tools: {
    web: {
      search: {
        provider: "perplexity",
      },
    },
  },
}

OpenRouter / Sonar 兼容模式

json5

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

配置 Key 的位置

通过配置文件： 运行 openclaw configure --section web，它会将 Key 存储在 ~/.openclaw/openclaw.json 的 plugins.entries.perplexity.config.webSearch.apiKey 下。该字段也接受 SecretRef 对象。

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

如果配置了 provider: "perplexity" 但 Perplexity Key SecretRef 无法解析且没有环境变量回退，启动/重载会立即失败。

工具参数

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

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

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

示例：

javascript

// 按国家和语言搜索
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 或显式设置 plugins.entries.perplexity.config.webSearch.baseUrl / model 会将 Perplexity 切回 Sonar chat completions 兼容模式
结果默认缓存 15 分钟（可通过 cacheTtlMinutes 配置）

Perplexity Search API ​

获取 Perplexity API Key ​

OpenRouter 兼容性 ​

配置示例 ​

原生 Perplexity Search API ​

OpenRouter / Sonar 兼容模式 ​

配置 Key 的位置 ​

工具参数 ​

域名过滤规则 ​

注意事项 ​

相关链接 ​