Pesquisa na Web

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.

​

Início rápido

openclaw configure --section web

await web_search({ query: "OpenClaw plugin SDK" });

await x_search({ query: "dinner recipes" });

​

Escolhendo um provedor

​

Comparação de provedores

​

Detecção automática

​

Pesquisa web nativa da OpenAI

​

Pesquisa web nativa do Codex

• Configure-a em tools.web.search.openaiCodex
• Ela só é ativada para modelos compatíveis com Codex (openai-codex/* ou provedores que usam api: "openai-codex-responses")
• A web_search gerenciada ainda se aplica a modelos não Codex
• mode: "cached" é a configuração padrão e recomendada
• tools.web.search.enabled: false desativa tanto a pesquisa gerenciada quanto a nativa

{
  tools: {
    web: {
      search: {
        enabled: true,
        openaiCodex: {
          enabled: true,
          mode: "cached",
          allowedDomains: ["example.com"],
          contextSize: "high",
          userLocation: {
            country: "US",
            city: "New York",
            timezone: "America/New_York",
          },
        },
      },
    },
  },
}

​

Segurança de rede

​

Configurando a pesquisa web

1. Brave — BRAVE_API_KEY ou plugins.entries.brave.config.webSearch.apiKey (ordem 10)
2. MiniMax Search — MINIMAX_CODE_PLAN_KEY / MINIMAX_CODING_API_KEY / MINIMAX_OAUTH_TOKEN / MINIMAX_API_KEY ou plugins.entries.minimax.config.webSearch.apiKey (ordem 15)
3. Gemini — plugins.entries.google.config.webSearch.apiKey, GEMINI_API_KEY ou models.providers.google.apiKey (ordem 20)
4. Grok — XAI_API_KEY ou plugins.entries.xai.config.webSearch.apiKey (ordem 30)
5. Kimi — KIMI_API_KEY / MOONSHOT_API_KEY ou plugins.entries.moonshot.config.webSearch.apiKey (ordem 40)
6. Perplexity — PERPLEXITY_API_KEY / OPENROUTER_API_KEY ou plugins.entries.perplexity.config.webSearch.apiKey (ordem 50)
7. Firecrawl — FIRECRAWL_API_KEY ou plugins.entries.firecrawl.config.webSearch.apiKey (ordem 60)
8. Exa — EXA_API_KEY ou plugins.entries.exa.config.webSearch.apiKey; plugins.entries.exa.config.webSearch.baseUrl opcional substitui o endpoint da Exa (ordem 65)
9. Tavily — TAVILY_API_KEY ou plugins.entries.tavily.config.webSearch.apiKey (ordem 70)

10. DuckDuckGo — fallback HTML sem chave, sem conta ou chave de API (ordem 100)
11. Ollama Web Search — fallback sem chave via seu host local do Ollama configurado quando ele estiver acessível e conectado com ollama signin; pode reutilizar a autenticação bearer do provedor Ollama quando o host precisar dela, e pode chamar a pesquisa direta em https://ollama.com quando configurado com OLLAMA_API_KEY (ordem 110)
12. SearXNG — SEARXNG_BASE_URL ou plugins.entries.searxng.config.webSearch.baseUrl (ordem 200)

​

Configuração

{
  tools: {
    web: {
      search: {
        enabled: true, // default: true
        provider: "brave", // or omit for auto-detection
        maxResults: 5,
        timeoutSeconds: 30,
        cacheTtlMinutes: 15,
      },
    },
  },
}

• escolha-o com tools.web.fetch.provider
• ou omita esse campo e deixe o OpenClaw detectar automaticamente o primeiro provedor de web-fetch pronto a partir das credenciais disponíveis
• web_fetch sem sandbox pode usar provedores de Plugins instalados que declaram contracts.webFetchProviders; buscas com sandbox permanecem apenas com os incluídos
• hoje, o provedor de web-fetch incluído é o Firecrawl, configurado em plugins.entries.firecrawl.config.webFetch.*

• a região da API Moonshot (https://api.moonshot.ai/v1 ou https://api.moonshot.cn/v1)
• o modelo padrão de busca na web do Kimi (padrão: kimi-k2.6)

​

Armazenar chaves de API

{
  plugins: {
    entries: {
      brave: {
        config: {
          webSearch: {
            apiKey: "YOUR_KEY", // pragma: allowlist secret
          },
        },
      },
    },
  },
}

export BRAVE_API_KEY="YOUR_KEY"

​

Parâmetros da ferramenta

​

x_search

​

Configuração de x_search

{
  plugins: {
    entries: {
      xai: {
        config: {
          xSearch: {
            enabled: true,
            model: "grok-4-1-fast-non-reasoning",
            baseUrl: "https://api.x.ai/v1", // optional, overrides webSearch.baseUrl
            inlineCitations: false,
            maxTurns: 2,
            timeoutSeconds: 30,
            cacheTtlMinutes: 15,
          },
          webSearch: {
            apiKey: "xai-...", // optional if an xAI auth profile or XAI_API_KEY is set
            baseUrl: "https://api.x.ai/v1", // optional shared xAI Responses base URL
          },
        },
      },
    },
  },
}

​

Parâmetros de x_search

​

Exemplo de x_search

await x_search({
  query: "dinner recipes",
  allowed_x_handles: ["nytfood"],
  from_date: "2026-03-01",
});

// Per-post stats: use the exact status URL or status ID when possible
await x_search({
  query: "https://x.com/huntharo/status/1905678901234567890",
});

​

Exemplos

// Basic search
await web_search({ query: "OpenClaw plugin SDK" });

// German-specific search
await web_search({ query: "TV online schauen", country: "DE", language: "de" });

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

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

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

​

Perfis de ferramentas

{
  tools: {
    allow: ["web_search", "x_search"],
    // or: allow: ["group:web"]  (includes web_search, x_search, and web_fetch)
  },
}

​

Relacionados

• Web Fetch — busca uma URL e extrai conteúdo legível
• Navegador web — automação completa de navegador para sites com muito JS
• Grok Search — Grok como o provedor de web_search
• Ollama Web Search — busca na web sem chave por meio do seu host Ollama