Firecrawl
- api_key (Optional[str]): API key for authenticating with the Firecrawl API.
- api_url (Optional[str]): Base URL for the Firecrawl API.
- References:
- https: //docs.firecrawl.dev/introduction
init
crawl
- url (str): The URL to crawl.
- params (Optional[Dict[str, Any]]): Additional parameters for the crawl request. Defaults to
None
. **kwargs (Any): Additional keyword arguments, such aspoll_interval
,idempotency_key
.
check_crawl_job
- job_id (str): The ID of the crawl job.
scrape
- url (str): The URL to read.
- params (Optional[Dict[str, str]]): Additional parameters for the scrape request.
structured_scrape
- url (str): The URL to read.
- response_format (BaseModel): A pydantic model that includes value types and field descriptions used to generate a structured response by LLM. This schema helps in defining the expected output format.
map_site
- url (str): The URL of the site to map.
- params (Optional[Dict[str, Any]]): Additional parameters for the map request. Defaults to
None
.