mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-24 23:58:15 +00:00
e16606672a
git-subtree-dir: packages/tools git-subtree-split: 78317b9c127f18bd040c1d77e3c0840cdc9a5b38
45 lines
1.0 KiB
Markdown
45 lines
1.0 KiB
Markdown
# FirecrawlSearchTool
|
|
|
|
## Description
|
|
|
|
[Firecrawl](https://firecrawl.dev) is a platform for crawling and convert any website into clean markdown or structured data.
|
|
|
|
## Installation
|
|
|
|
- Get an API key from [firecrawl.dev](https://firecrawl.dev) and set it in environment variables (`FIRECRAWL_API_KEY`).
|
|
- Install the [Firecrawl SDK](https://github.com/mendableai/firecrawl) along with `crewai[tools]` package:
|
|
|
|
```
|
|
pip install firecrawl-py 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
|
|
Utilize the FirecrawlSearchTool as follows to allow your agent to load websites:
|
|
|
|
```python
|
|
from crewai_tools import FirecrawlSearchTool
|
|
|
|
tool = FirecrawlSearchTool(config={"limit": 5})
|
|
tool.run(query="firecrawl web scraping")
|
|
```
|
|
|
|
## Arguments
|
|
|
|
- `api_key`: Optional. Specifies Firecrawl API key. Defaults is the `FIRECRAWL_API_KEY` environment variable.
|
|
- `config`: Optional. It contains Firecrawl API parameters.
|
|
|
|
|
|
This is the default configuration
|
|
|
|
```python
|
|
{
|
|
"limit": 5,
|
|
"tbs": None,
|
|
"lang": "en",
|
|
"country": "us",
|
|
"location": None,
|
|
"timeout": 60000,
|
|
}
|
|
```
|