> ## Documentation Index
> Fetch the complete documentation index at: https://hyperfx.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Firecrawl

> Set up and use the Firecrawl integration with Hyper AI

Auth type: API

<Info>
  For general setup steps, permissions, and troubleshooting, start with: [App Integrations](/integrations/overview).
</Info>

## Connect Firecrawl

1. Go to Settings → Apps in Hyper
2. Select Firecrawl → Connect New
3. Provide your Firecrawl API key

## Common capabilities

* Scrape websites and extract structured data
* Automate web crawling workflows
* Collect content from multiple pages at scale

## Use in Chat

Enable Firecrawl in the tool selector. Ask your agent to scrape a URL, extract data, or crawl a website.

## Use in Agents

Add Firecrawl to an agent's toolkits and select the connection. Mark actions as "requires approval" if desired.

## Use in Flows

Automate web scraping, data extraction, and content collection using Firecrawl action nodes.

## Troubleshooting

* Scraping failed: verify the target URL is accessible and not blocked
* API errors: check your API key and usage limits

***

## Available Actions

Hyper agents can run the following actions for this integration. Each action can be individually set to **Enabled**, **Requires Approval**, or **Disabled** in your agent's toolkit settings.

Actions can be set to one of three control states:

| State                 | Behavior                                                       |
| --------------------- | -------------------------------------------------------------- |
| **Enabled**           | Agent runs the action automatically                            |
| **Requires Approval** | Agent pauses and waits for your confirmation before proceeding |
| **Disabled**          | Action is blocked and cannot be used                           |

Configure these in the agent's toolkit settings or in workspace defaults.

| Action             | Description                                                                                                                                                                                    |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Batch Scrape       | Scrape multiple URLs in parallel and return all results using Firecrawl v2 API                                                                                                                 |
| Check Batch Status | Check the status of a batch scrape job and retrieve results if completed                                                                                                                       |
| Check Crawl Status | Check the status of a crawl job and retrieve results if completed                                                                                                                              |
| Crawl Website      | Crawl a website recursively and extract content from all accessible pages using Firecrawl v2 API. Supports natural language prompts to describe what to crawl                                  |
| Extract Branding   | Extract branding (colors, fonts, personality) and capture a screenshot from a website. Returns logo and screenshot with VFS paths ready to pass to image generation tools as reference\_images |
| Scrape Url         | Scrape a single URL and extract content in various formats (markdown, summary, html, json, etc.) using Firecrawl v2 API                                                                        |
| Screenshot         | Take a screenshot of a webpage. Saves the image and returns an AI description of what's visible on the page                                                                                    |