mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-08 15:48:29 +00:00
1a1bb0ca3d
* docs(cli): document device-code login and config reset guidance; renumber sections * docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections) * docs: Fix webhook documentation to include meta dict in all webhook payloads - Add note explaining that meta objects from kickoff requests are included in all webhook payloads - Update webhook examples to show proper payload structure including meta field - Fix webhook examples to match actual API implementation - Apply changes to English, Korean, and Portuguese documentation Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API. * WIP: CrewAI docs theme, changelog, GEO, localization * docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko) * docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
42 lines
1.5 KiB
Plaintext
42 lines
1.5 KiB
Plaintext
---
|
|
title: Firecrawl Search
|
|
description: The `FirecrawlSearchTool` is designed to search websites and convert them into clean markdown or structured data.
|
|
icon: fire-flame
|
|
mode: "wide"
|
|
---
|
|
|
|
# `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:
|
|
|
|
```shell
|
|
pip install firecrawl-py 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
|
|
Utilize the FirecrawlSearchTool as follows to allow your agent to load websites:
|
|
|
|
```python Code
|
|
from crewai_tools import FirecrawlSearchTool
|
|
|
|
tool = FirecrawlSearchTool(query='what is firecrawl?')
|
|
```
|
|
|
|
## Arguments
|
|
|
|
- `api_key`: Optional. Specifies Firecrawl API key. Defaults is the `FIRECRAWL_API_KEY` environment variable.
|
|
- `query`: The search query string to be used for searching.
|
|
- `page_options`: Optional. Options for result formatting.
|
|
- `onlyMainContent`: Optional. Only return the main content of the page excluding headers, navs, footers, etc.
|
|
- `includeHtml`: Optional. Include the raw HTML content of the page. Will output a html key in the response.
|
|
- `fetchPageContent`: Optional. Fetch the full content of the page.
|
|
- `search_options`: Optional. Options for controlling the crawling behavior.
|
|
- `limit`: Optional. Maximum number of pages to crawl. |