网页搜索

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

Use this file to discover all available pages before exploring further.

​

快速开始

openclaw configure --section web

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

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

​

选择提供商

​

提供商对比

​

自动检测

​

原生 OpenAI 网页搜索

​

原生 Codex 网页搜索

• 在 tools.web.search.openaiCodex 下进行配置
• 仅对支持 Codex 的模型生效（openai-codex/* 或使用 api: "openai-codex-responses" 的提供商）
• 托管的 web_search 仍然适用于非 Codex 模型
• mode: "cached" 是默认且推荐的设置
• tools.web.search.enabled: false 会同时禁用托管搜索和原生搜索

{
  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",
          },
        },
      },
    },
  },
}

​

网络安全

​

设置网页搜索

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

10. DuckDuckGo — 无需密钥的 HTML 回退方案，不需要账户或 API 密钥（顺序 100）
11. Ollama Web Search — 当你配置的本地 Ollama 主机可访问且已通过 ollama signin 登录时，可作为无需密钥的回退方案；当主机需要时可复用 Ollama 提供商 bearer 认证，并且在配置了 OLLAMA_API_KEY 时可调用直接的 https://ollama.com 搜索（顺序 110）
12. SearXNG — SEARXNG_BASE_URL 或 plugins.entries.searxng.config.webSearch.baseUrl（顺序 200）

​

配置

{
  tools: {
    web: {
      search: {
        enabled: true, // 默认：true
        provider: "brave", // 或省略以便自动检测
        maxResults: 5,
        timeoutSeconds: 30,
        cacheTtlMinutes: 15,
      },
    },
  },
}

• choose it with tools.web.fetch.provider
• or omit that field and let OpenClaw auto-detect the first ready web-fetch provider from available credentials
• non-sandboxed web_fetch can use installed plugin providers that declare contracts.webFetchProviders; sandboxed fetches stay bundled-only
• today the bundled web-fetch provider is Firecrawl, configured under plugins.entries.firecrawl.config.webFetch.*

• Moonshot API 区域（https://api.moonshot.ai/v1 或 https://api.moonshot.cn/v1）
• 默认的 Kimi 网页搜索模型（默认为 kimi-k2.6）

​

存储 API 密钥

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

export BRAVE_API_KEY="YOUR_KEY"

​

工具参数

​

x_search

​

x_search 配置

{
  plugins: {
    entries: {
      xai: {
        config: {
          xSearch: {
            enabled: true,
            model: "grok-4-1-fast-non-reasoning",
            baseUrl: "https://api.x.ai/v1", // 可选，覆盖 webSearch.baseUrl
            inlineCitations: false,
            maxTurns: 2,
            timeoutSeconds: 30,
            cacheTtlMinutes: 15,
          },
          webSearch: {
            apiKey: "xai-...", // 如果已设置 XAI_API_KEY，则可选
            baseUrl: "https://api.x.ai/v1", // 可选的共享 xAI Responses base URL
          },
        },
      },
    },
  },
}

​

x_search 参数

​

x_search 示例

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

// 单帖统计：尽可能使用精确的状态 URL 或状态 ID
await x_search({
  query: "https://x.com/huntharo/status/1905678901234567890",
});

​

示例

// 基础搜索
await web_search({ query: "OpenClaw plugin SDK" });

// 德语特定搜索
await web_search({ query: "TV online schauen", country: "DE", language: "de" });

// 最近结果（过去一周）
await web_search({ query: "AI developments", freshness: "week" });

// 日期范围
await web_search({
  query: "climate research",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

// 域名过滤（仅 Perplexity）
await web_search({
  query: "product reviews",
  domain_filter: ["-reddit.com", "-pinterest.com"],
});

​

工具配置文件

{
  tools: {
    allow: ["web_search", "x_search"],
    // 或：allow: ["group:web"]  （包含 web_search、x_search 和 web_fetch）
  },
}

​

相关内容

• Web Fetch — 获取 URL 并提取可读内容
• Web Browser — 针对 JS 密集型网站的完整浏览器自动化
• Grok Search — 将 Grok 作为 web_search 提供商
• Ollama Web Search — 通过你的 Ollama 主机进行免密钥网页搜索