2026-01-15 04:07:29 +00:00
|
|
|
|
---
|
|
|
|
|
|
summary: "Web search + fetch tools (Brave Search API)"
|
|
|
|
|
|
read_when:
|
|
|
|
|
|
- You want to enable web_search or web_fetch
|
|
|
|
|
|
- You need Brave Search API key setup
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# Web tools
|
|
|
|
|
|
|
|
|
|
|
|
Clawdbot ships two lightweight web tools:
|
|
|
|
|
|
|
|
|
|
|
|
- `web_search` — Brave Search API queries (fast, structured results).
|
|
|
|
|
|
- `web_fetch` — HTTP fetch + readable extraction (HTML → markdown/text).
|
|
|
|
|
|
|
|
|
|
|
|
These are **not** browser automation. For JS-heavy sites or logins, use the
|
|
|
|
|
|
[Browser tool](/tools/browser).
|
|
|
|
|
|
|
|
|
|
|
|
## How it works
|
|
|
|
|
|
|
|
|
|
|
|
- `web_search` calls Brave’s Search API and returns structured results
|
|
|
|
|
|
(title, URL, snippet). No browser is involved.
|
|
|
|
|
|
- Results are cached by query for 15 minutes (configurable).
|
|
|
|
|
|
- `web_fetch` does a plain HTTP GET and extracts readable content
|
|
|
|
|
|
(HTML → markdown/text). It does **not** execute JavaScript.
|
2026-01-15 07:42:01 +00:00
|
|
|
|
- `web_fetch` is enabled by default (unless explicitly disabled).
|
2026-01-15 04:07:29 +00:00
|
|
|
|
|
2026-01-15 04:25:19 +00:00
|
|
|
|
## Getting a Brave API key
|
|
|
|
|
|
|
|
|
|
|
|
1) Create a Brave Search API account at https://brave.com/search/api/
|
|
|
|
|
|
2) Generate an API key in the dashboard.
|
2026-01-15 05:08:51 +00:00
|
|
|
|
3) Run `clawdbot configure --section web` to store the key in config (recommended), or set `BRAVE_API_KEY` in your environment.
|
2026-01-15 04:25:19 +00:00
|
|
|
|
|
|
|
|
|
|
Brave provides a free tier plus paid plans; check the Brave API portal for the
|
|
|
|
|
|
current limits and pricing.
|
|
|
|
|
|
|
2026-01-15 05:08:51 +00:00
|
|
|
|
### Where to set the key (recommended)
|
|
|
|
|
|
|
|
|
|
|
|
**Recommended:** run `clawdbot configure --section web`. It stores the key in
|
|
|
|
|
|
`~/.clawdbot/clawdbot.json` under `tools.web.search.apiKey`.
|
|
|
|
|
|
|
|
|
|
|
|
**Environment alternative:** set `BRAVE_API_KEY` in the Gateway process
|
|
|
|
|
|
environment. For a daemon install, put it in `~/.clawdbot/.env` (or your
|
|
|
|
|
|
service environment). See [Env vars](/start/faq#how-does-clawdbot-load-environment-variables).
|
|
|
|
|
|
|
2026-01-15 04:07:29 +00:00
|
|
|
|
## web_search
|
|
|
|
|
|
|
|
|
|
|
|
Search the web with Brave’s API.
|
|
|
|
|
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
|
2026-01-15 07:42:01 +00:00
|
|
|
|
- `tools.web.search.enabled` must not be `false` (default: enabled)
|
2026-01-15 05:08:51 +00:00
|
|
|
|
- Brave API key (recommended: `clawdbot configure --section web`, or set `BRAVE_API_KEY`)
|
2026-01-15 04:07:29 +00:00
|
|
|
|
|
|
|
|
|
|
### Config
|
|
|
|
|
|
|
|
|
|
|
|
```json5
|
|
|
|
|
|
{
|
|
|
|
|
|
tools: {
|
|
|
|
|
|
web: {
|
|
|
|
|
|
search: {
|
|
|
|
|
|
enabled: true,
|
|
|
|
|
|
apiKey: "BRAVE_API_KEY_HERE", // optional if BRAVE_API_KEY is set
|
|
|
|
|
|
maxResults: 5,
|
|
|
|
|
|
timeoutSeconds: 30,
|
|
|
|
|
|
cacheTtlMinutes: 15
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Tool parameters
|
|
|
|
|
|
|
|
|
|
|
|
- `query` (required)
|
|
|
|
|
|
- `count` (1–10; default from config)
|
|
|
|
|
|
|
|
|
|
|
|
## web_fetch
|
|
|
|
|
|
|
|
|
|
|
|
Fetch a URL and extract readable content.
|
|
|
|
|
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
|
2026-01-15 07:42:01 +00:00
|
|
|
|
- `tools.web.fetch.enabled` must not be `false` (default: enabled)
|
2026-01-15 04:07:29 +00:00
|
|
|
|
|
|
|
|
|
|
### Config
|
|
|
|
|
|
|
|
|
|
|
|
```json5
|
|
|
|
|
|
{
|
|
|
|
|
|
tools: {
|
|
|
|
|
|
web: {
|
|
|
|
|
|
fetch: {
|
|
|
|
|
|
enabled: true,
|
|
|
|
|
|
maxChars: 50000,
|
|
|
|
|
|
timeoutSeconds: 30,
|
|
|
|
|
|
cacheTtlMinutes: 15,
|
|
|
|
|
|
userAgent: "clawdbot/2026.1.14"
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Tool parameters
|
|
|
|
|
|
|
|
|
|
|
|
- `url` (required, http/https only)
|
|
|
|
|
|
- `extractMode` (`markdown` | `text`)
|
|
|
|
|
|
- `maxChars` (truncate long pages)
|
|
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
- `web_fetch` is best-effort extraction; some sites will need the browser tool.
|
|
|
|
|
|
- Responses are cached (default 15 minutes) to reduce repeated fetches.
|
|
|
|
|
|
- If you use tool profiles/allowlists, add `web_search`/`web_fetch` or `group:web`.
|
2026-01-15 05:35:22 +00:00
|
|
|
|
- If the Brave key is missing, `web_search` returns a short setup hint with a docs link.
|