75775f2fe6
Merged via squash. Prepared head SHA: f8fc4bf01e0eacfb01f6ee58eea445680f7eeebd Co-authored-by: HenryLoenwind <1485873+HenryLoenwind@users.noreply.github.com> Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com> Reviewed-by: @gumadeiras
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
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 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.
|
|
|
|
See [Web tools](/tools/web) for the full web_search configuration.
|