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-... 格式的密钥，或设置了 plugins.entries.perplexity.config.webSearch.baseUrl/model，provider 会切换到 chat-completions 路径，返回带引用的 AI 合成答案，而非结构化搜索结果。

获取 Perplexity API Key

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

OpenRouter 兼容

若你之前通过 OpenRouter 使用 Perplexity Sonar，保留 provider: "perplexity" 并在 Gateway 环境中设置 OPENROUTER_API_KEY，或将 sk-or-... 格式的 Key 存入 plugins.entries.perplexity.config.webSearch.apiKey。

可选兼容性控制：

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

配置示例

原生 Perplexity Search API

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

OpenRouter / Sonar 兼容

{
  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（或你的服务环境）。参见 环境变量说明。

若配置了 provider: "perplexity" 但 Perplexity Key SecretRef 未解析且无环境变量回退，启动/重载时会快速失败。

工具参数

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

参数	说明
query	搜索查询（必填）
count	返回结果数量（1-10，默认：5）
country	2 字母 ISO 国家代码（如 "US"、"DE"）
language	ISO 639-1 语言代码（如 "en"、"de"、"fr"）
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 的过滤器会返回明确错误。

示例：

// 指定国家和语言的搜索
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 配置）

更多 web_search 配置见 Web 工具。 更多 Perplexity Search API 细节见 Perplexity Search API 文档。