mirror of
https://github.com/openclaw/openclaw.git
synced 2026-02-19 18:39:20 -05:00
578a6e27aa
* docs(markdownlint): enable autofixable rules except list numbering * docs(zalo): fix malformed bot platform link
42 lines
1018 B
Markdown
42 lines
1018 B
Markdown
---
|
|
summary: "Brave Search API setup for web_search"
|
|
read_when:
|
|
- You want to use Brave Search for web_search
|
|
- You need a BRAVE_API_KEY or plan details
|
|
title: "Brave Search"
|
|
---
|
|
|
|
# Brave Search API
|
|
|
|
OpenClaw uses Brave Search as the default provider for `web_search`.
|
|
|
|
## Get an API key
|
|
|
|
1. Create a Brave Search API account at [https://brave.com/search/api/](https://brave.com/search/api/)
|
|
2. In the dashboard, choose the **Data for Search** plan and generate an API key.
|
|
3. Store the key in config (recommended) or set `BRAVE_API_KEY` in the Gateway environment.
|
|
|
|
## Config example
|
|
|
|
```json5
|
|
{
|
|
tools: {
|
|
web: {
|
|
search: {
|
|
provider: "brave",
|
|
apiKey: "BRAVE_API_KEY_HERE",
|
|
maxResults: 5,
|
|
timeoutSeconds: 30,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The Data for AI plan is **not** compatible with `web_search`.
|
|
- Brave provides a free tier plus paid plans; check the Brave API portal for current limits.
|
|
|
|
See [Web tools](/tools/web) for the full web_search configuration.
|