Skip to main content

Brave Search Tools

Description

CrewAI offers a family of Brave Search tools, each targeting a specific Brave Search API endpoint. Rather than a single catch-all tool, you can pick exactly the tool that matches the kind of results your agent needs: All tools share a common base class (BraveSearchToolBase) that provides consistent behavior — rate limiting, automatic retries on 429 responses, header and parameter validation, and optional file saving.
The older BraveSearchTool class is still available for backwards compatibility, but it is considered legacy and will not receive the same level of attention going forward. We recommend migrating to the specific tools listed above, which offer richer configuration and a more focused interface.
While many tools (e.g., BraveWebSearchTool, BraveNewsSearchTool, BraveImageSearchTool, and BraveVideoSearchTool) can be used with a free Brave Search API subscription/plan, some parameters (e.g., enable_snippets) and tools (e.g., BraveLocalPOIsTool and BraveLocalPOIsDescriptionTool) require a paid plan. Consult your subscription plan’s capabilities for clarification.

Installation

Getting Started

  1. Install the package — confirm that crewai[tools] is installed in your Python environment.
  2. Get an API key — sign up at api-dashboard.search.brave.com/login to generate a key.
  3. Set the environment variable — store your key as BRAVE_API_KEY, or pass it directly via the api_key parameter.

Quick Examples

Code
Code
Code
Code

Location POI Descriptions

Code

Common Constructor Parameters

Every Brave Search tool accepts the following parameters at initialization:
The country and n_results constructor parameters exist for backwards compatibility. They are applied as defaults when the corresponding query parameters (country, count) are not provided at call time. For new code, we recommend passing country and count directly as query parameters instead.

Query Parameters

Each tool validates its query parameters against a Pydantic schema before sending the request. The parameters vary slightly per endpoint — here is a summary of the most commonly used ones:

BraveWebSearchTool

For the complete parameter and header reference, see the Brave Web Search API documentation.

BraveNewsSearchTool

For the complete parameter and header reference, see the Brave News Search API documentation.

BraveImageSearchTool

For the complete parameter and header reference, see the Brave Image Search API documentation.

BraveVideoSearchTool

For the complete parameter and header reference, see the Brave Video Search API documentation.

BraveLocalPOIsTool

For the complete parameter and header reference, see Brave Local POIs API documentation.

BraveLocalPOIsDescriptionTool

For the complete parameter and header reference, see Brave POI Descriptions API documentation.

Custom Headers

All tools support custom HTTP request headers. The Web Search tool, for example, accepts geolocation headers for location-aware results:
Code
You can also update headers after initialization using the set_headers() method:
Code

Raw Mode

By default, each tool refines the API response into a concise list of results. If you need the full, unprocessed API response, enable raw mode:
Code

Agent Integration Example

Here’s how to equip a CrewAI agent with multiple Brave Search tools:
Code

Advanced Example

Combining multiple parameters for a targeted search:
Code

Migrating from BraveSearchTool (Legacy)

If you are currently using BraveSearchTool, switching to the new tools is straightforward:
Code
Key differences:
  • Import: Use BraveWebSearchTool (or the news/image/video variant) instead of BraveSearchTool.
  • Query parameter: Use q instead of search_query. (Both search_query and query are still accepted for convenience, but q is the preferred parameter.)
  • Result count: Pass count as a query parameter instead of n_results at init time.
  • Country: Pass country as a query parameter instead of at init time.
  • API key: Can now be passed directly via api_key= in addition to the BRAVE_API_KEY environment variable.
  • Rate limiting: Configurable via requests_per_second with automatic retry on 429 responses.

Conclusion

The Brave Search tool suite gives your CrewAI agents flexible, endpoint-specific access to the Brave Search API. Whether you need web pages, breaking news, images, or videos, there is a dedicated tool with validated parameters and built-in resilience. Pick the tool that fits your use case, and refer to the Brave Search API documentation for the full details on available parameters and response formats.