mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
bf9e0423f2
Some checks failed
* WIP: v1 docs (#3626) (cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c) * docs: parity for all translations * docs: full name of acronym AMP * docs: fix lingering unused code * docs: expand contextual options in docs.json * docs: add contextual action to request feature on GitHub * chore: tidy docs formatting
65 lines
1.5 KiB
Plaintext
65 lines
1.5 KiB
Plaintext
---
|
|
title: SerpApi Google Search Tool
|
|
description: The `SerpApiGoogleSearchTool` performs Google searches using the SerpApi service.
|
|
icon: google
|
|
mode: "wide"
|
|
---
|
|
|
|
# `SerpApiGoogleSearchTool`
|
|
|
|
## Description
|
|
|
|
Use the `SerpApiGoogleSearchTool` to run Google searches with SerpApi and retrieve structured results. Requires a SerpApi API key.
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
uv add crewai-tools[serpapi]
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
- `SERPAPI_API_KEY` (required): API key for SerpApi. Create one at https://serpapi.com/ (free tier available).
|
|
|
|
## Example
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import SerpApiGoogleSearchTool
|
|
|
|
tool = SerpApiGoogleSearchTool()
|
|
|
|
agent = Agent(
|
|
role="Researcher",
|
|
goal="Answer questions using Google search",
|
|
backstory="Search specialist",
|
|
tools=[tool],
|
|
verbose=True,
|
|
)
|
|
|
|
task = Task(
|
|
description="Search for the latest CrewAI releases",
|
|
expected_output="A concise list of relevant results with titles and links",
|
|
agent=agent,
|
|
)
|
|
|
|
crew = Crew(agents=[agent], tasks=[task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Set `SERPAPI_API_KEY` in the environment. Create a key at https://serpapi.com/
|
|
- See also Google Shopping via SerpApi: `/en/tools/search-research/serpapi-googleshoppingtool`
|
|
|
|
## Parameters
|
|
|
|
### Run Parameters
|
|
|
|
- `search_query` (str, required): The Google query.
|
|
- `location` (str, optional): Geographic location parameter.
|
|
|
|
## Notes
|
|
|
|
- This tool wraps SerpApi and returns structured search results.
|