Passer au contenu principal

​
API Perplexity Search

OpenClaw prend en charge l’API Perplexity Search comme fournisseur web_search. Elle renvoie des résultats structurés avec les champs title, url et snippet. Pour des raisons de compatibilité, OpenClaw prend également en charge les anciennes configurations Perplexity Sonar/OpenRouter. Si vous utilisez OPENROUTER_API_KEY, une clé sk-or-... dans plugins.entries.perplexity.config.webSearch.apiKey, ou si vous définissez plugins.entries.perplexity.config.webSearch.baseUrl / model, le fournisseur bascule vers le chemin chat-completions et renvoie des réponses synthétisées par l’IA avec des citations au lieu des résultats structurés de l’API Search.

​
Obtenir une clé API Perplexity

  1. Créez un compte Perplexity sur perplexity.ai/settings/api
  2. Générez une clé API dans le tableau de bord
  3. Stockez la clé dans la configuration ou définissez PERPLEXITY_API_KEY dans l’environnement Gateway.

​
Compatibilité OpenRouter

Si vous utilisiez déjà OpenRouter pour Perplexity Sonar, conservez provider: "perplexity" et définissez OPENROUTER_API_KEY dans l’environnement Gateway, ou stockez une clé sk-or-... dans plugins.entries.perplexity.config.webSearch.apiKey. Contrôles de compatibilité facultatifs :
  • plugins.entries.perplexity.config.webSearch.baseUrl
  • plugins.entries.perplexity.config.webSearch.model

​
Exemples de configuration

​
API Perplexity Search native

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

​
Compatibilité 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",
      },
    },
  },
}

​
Où définir la clé

Via la configuration : exécutez openclaw configure --section web. La clé est stockée dans ~/.openclaw/openclaw.json sous plugins.entries.perplexity.config.webSearch.apiKey. Ce champ accepte également des objets SecretRef. Via l’environnement : définissez PERPLEXITY_API_KEY ou OPENROUTER_API_KEY dans l’environnement du processus Gateway. Pour une installation Gateway, placez-la dans ~/.openclaw/.env (ou dans l’environnement de votre service). Consultez Variables d’environnement. Si provider: "perplexity" est configuré et que la clé Perplexity via SecretRef n’est pas résolue sans solution de repli par variable d’environnement, le démarrage/rechargement échoue immédiatement.

​
Paramètres de l’outil

Ces paramètres s’appliquent au chemin natif de l’API Perplexity Search.
ParamètreDescription
queryRequête de recherche (obligatoire)
countNombre de résultats à renvoyer (1-10, par défaut : 5)
countryCode pays ISO à 2 lettres (par ex. "US", "DE")
languageCode de langue ISO 639-1 (par ex. "en", "de", "fr")
freshnessFiltre temporel : day (24 h), week, month ou year
date_afterUniquement les résultats publiés après cette date (YYYY-MM-DD)
date_beforeUniquement les résultats publiés avant cette date (YYYY-MM-DD)
domain_filterTableau de liste d’autorisation/de refus de domaines (max. 20)
max_tokensBudget total de contenu (par défaut : 25000, max. : 1000000)
max_tokens_per_pageLimite de jetons par page (par défaut : 2048)
Pour l’ancien chemin de compatibilité Sonar/OpenRouter :
  • query, count et freshness sont acceptés
  • count n’est présent que pour la compatibilité ; la réponse reste une unique réponse synthétisée avec des citations plutôt qu’une liste de N résultats
  • Les filtres réservés à l’API Search, comme country, language, date_after, date_before, domain_filter, max_tokens et max_tokens_per_page, renvoient des erreurs explicites
Exemples : 
// Recherche spécifique à un pays et à une langue
await web_search({
  query: "renewable energy",
  country: "DE",
  language: "de",
});

// Résultats récents (semaine passée)
await web_search({
  query: "AI news",
  freshness: "week",
});

// Recherche sur une plage de dates
await web_search({
  query: "AI developments",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

// Filtrage de domaines (liste d’autorisation)
await web_search({
  query: "climate research",
  domain_filter: ["nature.com", "science.org", ".edu"],
});

// Filtrage de domaines (liste de refus - préfixer avec -)
await web_search({
  query: "product reviews",
  domain_filter: ["-reddit.com", "-pinterest.com"],
});

// Extraction de contenu plus importante
await web_search({
  query: "detailed AI research",
  max_tokens: 50000,
  max_tokens_per_page: 4096,
});

​
Règles du filtre de domaine

  • Maximum de 20 domaines par filtre
  • Impossible de mélanger liste d’autorisation et liste de refus dans la même requête
  • Utilisez le préfixe - pour les entrées de liste de refus (par ex. ["-reddit.com"])

​
Remarques

  • L’API Perplexity Search renvoie des résultats de recherche web structurés (title, url, snippet)
  • OpenRouter ou plugins.entries.perplexity.config.webSearch.baseUrl / model explicite rebascule Perplexity vers les chat completions Sonar pour des raisons de compatibilité
  • La compatibilité Sonar/OpenRouter renvoie une unique réponse synthétisée avec des citations, et non des lignes de résultats structurées
  • Les résultats sont mis en cache pendant 15 minutes par défaut (configurable via cacheTtlMinutes)

​
Lié