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.
Brave Search API
OpenClaw supports Brave Search API as aweb_search provider.
Get an API key
- Create a Brave Search API account at https://brave.com/search/api/
- In the dashboard, choose the Search plan and generate an API key.
- Store the key in config or set
BRAVE_API_KEYin the Gateway environment.
Config example
plugins.entries.brave.config.webSearch.*.
Legacy tools.web.search.apiKey still loads through the compatibility shim, but it is no longer the canonical config path.
webSearch.mode controls the Brave transport:
web(default): normal Brave web search with titles, URLs, and snippetsllm-context: Brave LLM Context API with pre-extracted text chunks and sources for grounding
webSearch.baseUrl can point Brave requests at a trusted Brave-compatible proxy
or gateway. OpenClaw appends /res/v1/web/search or /res/v1/llm/context to
the configured base URL and keeps the base URL in the cache key. Public
endpoints must use https://; http:// is accepted only for trusted loopback
or private-network proxy hosts.
Tool parameters
Search query.
Number of results to return (1–10).
2-letter ISO country code (e.g.
US, DE).ISO 639-1 language code for search results (e.g.
en, de, fr).Brave search-language code (e.g.
en, en-gb, zh-hans).ISO language code for UI elements.
Time filter —
day is 24 hours.Only results published after this date (
YYYY-MM-DD).Only results published before this date (
YYYY-MM-DD).Notes
- OpenClaw uses the Brave Search plan. If you have a legacy subscription (e.g. the original Free plan with 2,000 queries/month), it remains valid but does not include newer features like LLM Context or higher rate limits.
- Each Brave plan includes $5/month in free credit (renewing). The Search plan costs $5 per 1,000 requests, so the credit covers 1,000 queries/month. Set your usage limit in the Brave dashboard to avoid unexpected charges. See the Brave API portal for current plans.
- The Search plan includes the LLM Context endpoint and AI inference rights. Storing results to train or tune models requires a plan with explicit storage rights. See the Brave Terms of Service.
llm-contextmode returns grounded source entries instead of the normal web-search snippet shape.llm-contextmode supportsfreshnessand boundeddate_after+date_beforeranges. It does not supportui_lang;date_beforewithoutdate_afteris rejected because Brave requires custom freshness ranges to include both start and end dates.ui_langmust include a region subtag likeen-US.- Results are cached for 15 minutes by default (configurable via
cacheTtlMinutes). - Custom
webSearch.baseUrlvalues are included in Brave cache identity, so proxy-specific responses do not collide. - Enable the
brave.httpdiagnostics flag to log Brave request URLs/query params, response status/timing, and search-cache hit/miss/write events while troubleshooting. The flag never logs the API key or response bodies, but search queries can be sensitive.
Related
- Web Search overview — all providers and auto-detection
- Perplexity Search — structured results with domain filtering
- Exa Search — neural search with content extraction