Tools
Perplexity 検索
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 パスに切り替わり、構造化された Search API 結果ではなく、引用付きの AI 合成回答を返します。
Perplexity API キーの取得
- perplexity.ai/settings/api で Perplexity アカウントを作成する
- ダッシュボードで API キーを生成する
- キーを設定に保存するか、Gateway 環境で
PERPLEXITY_API_KEYを設定します。
OpenRouter 互換性
すでに Perplexity Sonar 用に OpenRouter を使用していた場合は、provider: "perplexity" を維持し、Gateway 環境で OPENROUTER_API_KEY を設定するか、plugins.entries.perplexity.config.webSearch.apiKey に sk-or-... キーを保存します。
任意の互換性制御:
plugins.entries.perplexity.config.webSearch.baseUrlplugins.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_KEY または OPENROUTER_API_KEY
を設定します。Gateway インストールの場合は、
~/.openclaw/.env(またはサービス環境)に配置します。環境変数を参照してください。
provider: "perplexity" が設定されていて、Perplexity キー SecretRef が未解決で env フォールバックもない場合、起動/再読み込みは即座に失敗します。
ツールパラメーター
これらのパラメーターは、ネイティブ Perplexity Search API パスに適用されます。
querystringrequired検索クエリ。
countnumberdefault: 5返す結果数(1〜10)。
countrystring2 文字の ISO 国コード(例: US、DE)。
languagestringISO 639-1 言語コード(例: en、de、fr)。
freshness'day' | 'week' | 'month' | 'year'時間フィルター - day は 24 時間です。
date_afterstringこの日付(YYYY-MM-DD)より後に公開された結果のみ。
date_beforestringこの日付(YYYY-MM-DD)より前に公開された結果のみ。
domain_filterstring[]ドメインの許可リスト/拒否リスト配列(最大 20)。
max_tokensnumberdefault: 25000合計コンテンツ予算(最大 1000000)。
max_tokens_per_pagenumberdefault: 2048ページごとのトークン上限。
従来の Sonar/OpenRouter 互換性パスの場合:
query、count、freshnessが受け入れられます- そこでの
countは互換性専用です。レスポンスは N 件の結果リストではなく、引用付きの 1 つの合成回答のままです country、language、date_after、date_before、domain_filter、max_tokens、max_tokens_per_pageなどの Search API 専用フィルターは明示的なエラーを返します
例:
// Country and language-specific searchawait web_search({ query: "renewable energy", country: "DE", language: "de",}); // Recent results (past week)await web_search({ query: "AI news", freshness: "week",}); // Date range searchawait 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 extractionawait web_search({ query: "detailed AI research", max_tokens: 50000, max_tokens_per_page: 4096,});ドメインフィルターのルール
- フィルターごとに最大 20 ドメイン
- 同じリクエスト内で許可リストと拒否リストを混在させることはできません
- 拒否リスト項目には
-プレフィックスを使用します(例:["-reddit.com"])
注記
- Perplexity Search API は構造化された Web 検索結果(
title、url、snippet)を返します - OpenRouter または明示的な
plugins.entries.perplexity.config.webSearch.baseUrl/modelは、互換性のために Perplexity を Sonar chat completions に戻します - Sonar/OpenRouter 互換性は、構造化された結果行ではなく、引用付きの 1 つの合成回答を返します
- 結果はデフォルトで 15 分間キャッシュされます(
cacheTtlMinutesで設定可能)