Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

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

​
Perplexity Search API

OpenClaw 支持 Perplexity Search API 作为 web_search 提供方。 它返回带有 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，提供方会切换到 chat-completions 路径，并返回带引文的 AI 合成答案，而不是结构化的 Search API 结果。

​
获取 Perplexity API 密钥

  1. 在 perplexity.ai/settings/api 创建一个 Perplexity 账户
  2. 在控制台中生成一个 API 密钥
  3. 将该密钥存储在配置中，或在 Gateway 环境中设置 PERPLEXITY_API_KEY

​
OpenRouter 兼容性

如果你之前一直在使用 OpenRouter 配合 Perplexity Sonar，请保留 provider: "perplexity"，并在 Gateway 环境中设置 OPENROUTER_API_KEY，或者在 plugins.entries.perplexity.config.webSearch.apiKey 中存储一个 sk-or-... 密钥。 可选的兼容性控制项：
  • 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",
      },
    },
  },
}

​
在哪里设置密钥

通过配置： 运行 openclaw configure --section web。它会将密钥存储在 ~/.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
string
required
搜索查询。
​
count
number
default:"5"
返回结果数量（1–10）。
​
country
string
2 位 ISO 国家代码（例如 US、DE）。
​
language
string
ISO 639-1 语言代码（例如 en、de、fr）。
​
freshness
'day' | 'week' | 'month' | 'year'
时间筛选 — day 表示 24 小时。
​
date_after
string
仅返回在此日期之后发布的结果（YYYY-MM-DD）。
​
date_before
string
仅返回在此日期之前发布的结果（YYYY-MM-DD）。
​
domain_filter
string[]
域名白名单/黑名单数组（最多 20 个）。
​
max_tokens
number
default:"25000"
总内容预算（最大 1000000）。
​
max_tokens_per_page
number
default:"2048"
每页 token 限制。
对于旧版 Sonar/OpenRouter 兼容路径：
  • 接受 query、count 和 freshness
  • 其中 count 仅用于兼容；返回结果仍然是带引文的一条合成答案，而不是 N 条结果列表
  • 仅适用于 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 或显式设置 plugins.entries.perplexity.config.webSearch.baseUrl / model 会将 Perplexity 切回 Sonar chat completions，以保持兼容性
  • Sonar/OpenRouter 兼容性返回一条带引文的合成答案，而不是结构化结果行
  • 结果默认缓存 15 分钟（可通过 cacheTtlMinutes 配置）

​
相关内容