Files
openclaw/docs/brave-search.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

2026-01-18 01:42:40 +00:00
---
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"
2026-01-18 01:42:40 +00:00
---
# Brave Search API
2026-01-30 03:15:10 +01:00
OpenClaw uses Brave Search as the default provider for `web_search`.
2026-01-18 01:42:40 +00:00
## Get an API key
1. Create a Brave Search API account at [https://brave.com/search/api/](https://brave.com/search/api/)
2026-01-31 21:13:13 +09:00
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.
2026-01-18 01:42:40 +00:00
## Config example
```json5
{
tools: {
web: {
search: {
provider: "brave",
apiKey: "BRAVE_API_KEY_HERE",
maxResults: 5,
2026-01-31 21:13:13 +09:00
timeoutSeconds: 30,
},
},
},
2026-01-18 01:42:40 +00:00
}
```
## Notes
- The Data for AI plan is **not** compatible with `web_search`.
- Brave provides paid plans; check the Brave API portal for current limits.
- Brave Terms include restrictions on some AI-related uses of Search Results. Review the Brave Terms of Service and confirm your intended use is compliant. For legal questions, consult your counsel.
2026-01-18 01:42:40 +00:00
See [Web tools](/tools/web) for the full web_search configuration.