跳转到主要内容

Perplexity Search API

OpenClaw 支持 Perplexity Search API 作为 web_search 提供商。 它返回带有 titleurlsnippet 字段的结构化结果。 为了兼容性,OpenClaw 也支持传统的 Perplexity Sonar/OpenRouter 设置。 如果您使用 OPENROUTER_API_KEYplugins.entries.perplexity.config.webSearch.apiKey 中的 sk-or-... 密钥,或者设置了 plugins.entries.perplexity.config.webSearch.baseUrl / model,该提供商将切换到聊天补全路径,并返回带有引用的 AI 综合答案,而不是结构化的搜索 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。它会将密钥存储在 plugins.entries.perplexity.config.webSearch.apiKey 下的 ~/.openclaw/openclaw.json 中。 该字段也接受 SecretRef 对象。 通过环境变量: 在 Gateway(网关) 进程环境中设置 PERPLEXITY_API_KEYOPENROUTER_API_KEY。 对于 gateway 安装,将其放入 ~/.openclaw/.env(或您的服务环境)。参见 Env vars 如果配置了 provider: "perplexity" 且 Perplexity 密钥 SecretRef 未解析且没有环境变量回退,启动/重载将快速失败。

工具参数

这些参数适用于原生 Perplexity Search API 路径。
参数描述
query搜索查询(必填)
count要返回的结果数量(1-10,默认值:5)
country两位字母 ISO 国家代码(例如 “US”、“DE”)
languageISO 639-1 语言代码(例如 “en”、“de”、“fr”)
freshness时间过滤器:day (24h)、weekmonthyear
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 兼容性路径,仅支持 queryfreshness。 仅限搜索 API 的过滤器,例如 countrylanguagedate_afterdate_beforedomain_filtermax_tokensmax_tokens_per_page,将返回明确的错误。 示例:
// Country and language-specific search
await web_search({
  query: "renewable energy",
  country: "DE",
  language: "de",
});

// Recent results (past week)
await web_search({
  query: "AI news",
  freshness: "week",
});

// Date range search
await web_search({
  query: "AI developments",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

// Domain filtering (allowlist)
await web_search({
  query: "climate research",
  domain_filter: ["nature.com", "science.org", ".edu"],
});

// Domain filtering (denylist - prefix with -)
await web_search({
  query: "product reviews",
  domain_filter: ["-reddit.com", "-pinterest.com"],
});

// More content extraction
await web_search({
  query: "detailed AI research",
  max_tokens: 50000,
  max_tokens_per_page: 4096,
});

域名过滤规则

  • 每个过滤器最多 20 个域名
  • 不能在同一请求中混合使用允许列表和阻止列表
  • 对阻止列表条目使用 - 前缀(例如 ["-reddit.com"]

注意事项

  • Perplexity Search API 返回结构化的网页搜索结果(titleurlsnippet
  • OpenRouter 或显式的 plugins.entries.perplexity.config.webSearch.baseUrl / model 会将 Perplexity 切换回 Sonar 聊天补全模式以保持兼容性
  • 结果默认缓存 15 分钟(可通过 cacheTtlMinutes 配置)
有关完整的 web_search 配置,请参阅 Web tools。 有关更多详细信息,请参阅 Perplexity Search API docs
本页面源自 openclaw/openclaw,由 BeaversLab 翻译,遵循 MIT 协议 发布。
Last modified on March 27, 2026