跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/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 金鑰 SecretRef 無法解析又沒有 env 後援，啟動/重新載入會快速失敗。

​
工具參數

這些參數適用於原生 Perplexity Search API 路徑。
​
query
string
必填
搜尋查詢。
​
count
number
預設值:"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
預設值:"25000"
總內容預算（最多 1000000）。
​
max_tokens_per_page
number
預設值:"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 會回傳明確錯誤
範例： 
// 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 會回傳結構化的網頁搜尋結果（title、url、snippet）
  • OpenRouter 或明確的 plugins.entries.perplexity.config.webSearch.baseUrl / model 會為了相容性將 Perplexity 切回 Sonar chat completions
  • Sonar/OpenRouter 相容性會回傳一個帶有引用的合成答案，而不是結構化結果列
  • 結果預設會快取 15 分鐘（可透過 cacheTtlMinutes 設定）

​
相關