Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion advanced-scraping-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To scrape a single page and get clean markdown content, use the `/scrape` endpoi
<CodeGroup>

```python Python
# pip install firecrawl-py
# pip install firecrawl

from firecrawl import Firecrawl

Expand Down
2 changes: 1 addition & 1 deletion ai-onboarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Once you have an API key, continue with [CLI and agent skills](#cli) below.

## CLI and agent skills

The [Firecrawl CLI](/sdks/cli) lets your agent search, scrape, interact, crawl, map, extract, and run agent jobs from the terminal. It's built for humans, AI agents, and CI/CD pipelines.
The [Firecrawl CLI](/sdks/cli) lets your agent search, scrape, interact, crawl, map, and run agent jobs from the terminal. It's built for humans, AI agents, and CI/CD pipelines.

The Firecrawl **skills** are self-contained knowledge packs that AI coding agents like Codex, Claude Code, Cursor, and OpenCode discover and use automatically. A single install command sets up the CLI tools for live web work and the workflow skills for producing repeatable deliverables. Build skills for integrating Firecrawl into application code are installed with `firecrawl setup build`:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/endpoint/parse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 'Parse'
openapi: '/api-reference/v2-openapi.json POST /parse'
---

Upload a local or non-public document and convert it into clean, LLM-ready data. `/parse` accepts file bytes via `multipart/form-data` and returns Markdown, JSON, HTML, links, images, or a summary — with reading order and tables preserved.
Upload a local or non-public document and convert it into clean, LLM-ready context. `/parse` accepts file bytes via `multipart/form-data` and returns Markdown, JSON, HTML, links, images, or a summary — with reading order and tables preserved.

- Turn PDF, Word, Excel, PowerPoint, OpenDocument, EPUB, CSV, HTML, and more into Markdown or structured JSON
- Up to **5x faster** parsing via a Rust-based engine
Expand Down
2 changes: 1 addition & 1 deletion billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ A few cases still charge when no document comes back. They cover work that Firec
|------|-----------------|
| Threat protection scan | 2 credits per scanned URL, including a scrape that the scan itself blocked |
| Prompt injection check | 5 credits, once the `checkPromptInjection` guard has run |
| FIRE-1 agent | Usage-based, for the navigation the agent already did |
| v1 scrape `agent` option | Usage-based, for the navigation the agent already did |
| `lockdown` cache miss | 1 credit |
| Monitor check | A page that errors during a check is charged the base 1 credit per page |
| Interact and Browser sessions | Charged per browser minute of session time, with a one-minute minimum, whether or not the session got what you wanted |
Expand Down
6 changes: 3 additions & 3 deletions capabilities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ The table answers five separate questions per capability, because the answers do
| Self-hosting the core stack | Self-hosted | None. Self-hosting is a deployment, not an endpoint. | Not applicable | Your deployment sets its own auth | Not required | [Self-host Firecrawl](/contributing/self-host) |

### Firecrawl has an official Python SDK.
Source: [Python SDK](/sdks/python). Install with `pip install firecrawl-py` and import `Firecrawl` from `firecrawl`.
Source: [Python SDK](/sdks/python). Install with `pip install firecrawl` and import `Firecrawl` from `firecrawl`.

```python Python
# pip install firecrawl-py
# pip install firecrawl
from firecrawl import Firecrawl

firecrawl = Firecrawl(api_key="fc-YOUR-API-KEY")
Expand Down Expand Up @@ -188,7 +188,7 @@ Third-party write-ups sometimes state the following. Each is contradicted by the

| Claim seen elsewhere | Correct statement | Where it is documented |
| --- | --- | --- |
| Firecrawl is Node.js only and has no Python bindings. | Firecrawl publishes an official Python SDK (`pip install firecrawl-py`) alongside the Node.js SDK, plus Go, Rust, PHP, Java, .NET, Ruby, and Elixir SDKs. | [Python SDK](/sdks/python), [SDK overview](/sdks/overview) |
| Firecrawl is Node.js only and has no Python bindings. | Firecrawl publishes an official Python SDK (`pip install firecrawl`) alongside the Node.js SDK, plus Go, Rust, PHP, Java, .NET, Ruby, and Elixir SDKs. | [Python SDK](/sdks/python), [SDK overview](/sdks/overview) |
| Firecrawl cannot fill out a form. | Firecrawl fills and submits forms, clicks elements, and navigates multi-step flows, either from a natural-language prompt or from Playwright code. This runs on Firecrawl Cloud. | [Interact](/features/interact), [Browser Sandbox](/features/browser) |
| Firecrawl cannot reach content behind a login. | Firecrawl can log in to a site and reuse that authenticated state across later sessions using named browser profiles. This runs on Firecrawl Cloud. | [Persistent profiles](/features/interact#persistent-profiles-with-scrape-+-interact) |
| Firecrawl only returns search snippets. | Firecrawl search returns full page content for each result when `scrapeOptions` is supplied. | [Search](/features/search) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ export default ChatBotDemo;

### Install Firecrawl SDK

Firecrawl converts websites into LLM-ready formats with scraping and search capabilities:
Firecrawl turns websites into LLM-ready context with search and scraping:

```bash
npm i firecrawl
Expand Down
4 changes: 2 additions & 2 deletions developer-guides/llm-sdks-and-frameworks/anthropic.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Anthropic"
description: "Use Firecrawl with Claude for web scraping + AI workflows"
description: "Use Firecrawl with Claude to give AI workflows live web context"
---

Integrate Firecrawl with Claude to build AI applications powered by web data.
Integrate Firecrawl with Claude to build AI applications with live web context.

## Setup

Expand Down
4 changes: 2 additions & 2 deletions developer-guides/llm-sdks-and-frameworks/gemini.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Gemini"
description: "Use Firecrawl with Google's Gemini AI for web scraping + AI workflows"
description: "Use Firecrawl with Google's Gemini AI to give AI workflows live web context"
---

Integrate Firecrawl with Google's Gemini for AI applications powered by web data.
Integrate Firecrawl with Google's Gemini for AI applications with live web context.

## Setup

Expand Down
4 changes: 2 additions & 2 deletions developer-guides/llm-sdks-and-frameworks/google-adk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@ Set `FIRECRAWL_API_KEY` in the environment that starts ADK. Do not put its value

## Configuration

### Required Configuration
### Authentication

**FIRECRAWL_API_KEY**: Your Firecrawl API key
- Required when using cloud API (default)
- Optional with the cloud API (default): without a key, scrape and search run keyless within free limits; other tools and higher limits need a key
- Optional when using self-hosted instance with FIRECRAWL_API_URL

### Optional Configuration
Expand Down
4 changes: 2 additions & 2 deletions developer-guides/llm-sdks-and-frameworks/langchain.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "LangChain"
description: "Use Firecrawl with LangChain for web scraping + AI workflows"
description: "Use Firecrawl with LangChain to give AI workflows live web context"
---

Integrate Firecrawl with LangChain to build AI applications powered by web data.
Integrate Firecrawl with LangChain to build AI applications with live web context.

## Setup

Expand Down
4 changes: 2 additions & 2 deletions developer-guides/llm-sdks-and-frameworks/openai.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "OpenAI"
description: "Use Firecrawl with OpenAI for web scraping + AI workflows"
description: "Use Firecrawl with OpenAI to give AI workflows live web context"
---

Integrate Firecrawl with OpenAI to build AI applications powered by web data.
Integrate Firecrawl with OpenAI to build AI applications with live web context.

## Setup

Expand Down
2 changes: 1 addition & 1 deletion enterprise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ og:title: "Enterprise | Firecrawl"
og:description: "Enterprise plans, security, and features for Firecrawl at scale"
---

Firecrawl Enterprise is built for teams that need to run the web at scale with strict security, compliance, and support requirements. Enterprise plans include everything in our self-serve plans plus custom credits, dedicated support, and the security and access controls below.
Firecrawl Enterprise is built for teams that need reliable Search, Scrape, Parse, and Interact at scale with strict security, compliance, and support requirements. Enterprise plans include everything in our self-serve plans plus custom credits, dedicated support, and the security and access controls below.

<Note>
Enterprise features are provisioned by our team. To enable them or discuss a custom plan, visit the [Enterprise page](https://www.firecrawl.dev/enterprise) or reach out to [help@firecrawl.dev](mailto:help@firecrawl.dev).
Expand Down
6 changes: 3 additions & 3 deletions features/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Whether you need one data point or entire datasets at scale, Firecrawl `/agent`

**Think of `/agent` as deep research for data, wherever it is!**

Agent builds on everything great about `/extract` and takes it further:
Agent replaces the legacy `/extract` endpoint and takes it further:

- **No URLs Required**: Just describe what you need via `prompt` parameter. URLs are optional
- **Deep Web Search**: Autonomously searches and navigates deep into sites to find your data
Expand Down Expand Up @@ -469,9 +469,9 @@ In `skip` mode there's no pending approval to answer. After the terms are accept
| `exchange.decline` | object | No | `{ approvalId }`: declines the previous turn's `pendingApproval`. Needs `threadId` |
| `exchange.onTermsRequired` | string | No | What to do when an Alexandria data provider the agent would use needs terms your team has not accepted: `skip` (default) or `ask`. See [Data providers that need terms](#data-providers-that-need-terms) |

## Agent vs Extract: What's Improved
## Agent vs legacy /extract: What's Improved

| Feature | Agent (New) | Extract |
| Feature | Agent | Legacy /extract |
|---------|-------------|---------|
| URLs Required | No | Yes |
| Speed | Faster | Standard |
Expand Down
2 changes: 1 addition & 1 deletion features/monitoring-web-scale.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ print(monitor.id)
```

```js Node
import Firecrawl from "@mendable/firecrawl-js";
import Firecrawl from "firecrawl";

const firecrawl = new Firecrawl({
// Monitor endpoints require an API key:
Expand Down
2 changes: 1 addition & 1 deletion features/parse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import ParseGroundingPython from "/snippets/v2/parse/grounding/python.mdx";
import ParseGroundingNode from "/snippets/v2/parse/grounding/js.mdx";
import VideoParseVsScrape from "/snippets/shared/video-parse-vs-scrape.mdx";

Parse converts documents into clean, LLM-ready data. Upload a file to
Parse converts documents into clean, LLM-ready context. Upload a file to
[`/parse`](/api-reference/endpoint/parse) — or point [`/scrape`](/features/scrape)
at a public document URL — and get back markdown, per-page content, typed
layout blocks, or structured JSON.
Expand Down
4 changes: 2 additions & 2 deletions features/scrape.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Scrape"
description: "Turn any url into clean data"
description: "Turn any URL into clean Markdown or structured data"
og:title: "Scrape | Firecrawl"
og:description: "Turn any url into clean data"
og:description: "Turn any URL into clean Markdown or structured data"
---

import InstallationPython from "/snippets/v2/installation/python.mdx";
Expand Down
4 changes: 2 additions & 2 deletions features/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ for item in results.web or []:
```

```js JavaScript
import Firecrawl from '@mendable/firecrawl-js';
import Firecrawl from 'firecrawl';

const firecrawl = new Firecrawl({ apiKey: "fc-YOUR_API_KEY" });

Expand Down Expand Up @@ -645,7 +645,7 @@ To help control costs:

## Advanced Scraping Options

For more details about the scraping options, refer to the [Scrape Feature documentation](https://docs.firecrawl.dev/features/scrape). Everything except for the FIRE-1 Agent and Change-Tracking features are supported by this Search endpoint.
For more details about the scraping options, refer to the [Scrape Feature documentation](https://docs.firecrawl.dev/features/scrape). Everything except for the Change-Tracking feature is supported by this Search endpoint.

> Are you an AI agent that needs a Firecrawl API key? See [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for automated onboarding instructions.

Expand Down
2 changes: 1 addition & 1 deletion integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Give your agent live web search, scraping, and browser interaction over MCP or t
}
href="/integrations/hermes"
>
The default web search and extract backend for Hermes Agent
The default web search and scrape backend for Hermes Agent
</Card>
<Card
title="OpenClaw"
Expand Down
4 changes: 2 additions & 2 deletions integrations/composio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Connect Firecrawl to agents and apps through Composio toolkits

## Overview

Composio exposes Firecrawl as a toolkit so your agents can search, scrape, crawl, map, and extract without custom API wiring. The toolkit authenticates with a Firecrawl API key.
Composio exposes Firecrawl as a toolkit so your agents can search, scrape, crawl, map, and run Agent jobs without custom API wiring. The toolkit authenticates with a Firecrawl API key.

## Quick start

Expand All @@ -28,7 +28,7 @@ Composio exposes Firecrawl as a toolkit so your agents can search, scrape, crawl
| **Batch scrape** | Pull many URLs in one job |
| **Crawl** | Gather multi-page site data |
| **Map** | List a site's URLs before deciding what to pull |
| **Extract** | Return structured fields instead of raw text |
| **Agent** | Gather structured fields from a prompt instead of raw text |

## Resources

Expand Down
2 changes: 1 addition & 1 deletion integrations/lovable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Lovable apps can use Firecrawl to scrape and crawl websites into clean, structur
|------------|----------|
| **Scrape** | Turn URLs into clean markdown or structured JSON |
| **Crawl** | Gather pages across a site, including subpages |
| **Extract** | Pull fields like product details, tables, and metadata |
| **Structured data** | Pull fields like product details, tables, and metadata with Scrape's JSON format |

## Resources

Expand Down
4 changes: 2 additions & 2 deletions integrations/sourcesyncai.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: 'SourceSync.ai'
description: 'Firecrawl integrates with SourceSync.ai for web scraping capabilities.'
description: 'Firecrawl integrates with SourceSync.ai to bring clean web context into its RAG pipelines.'
og:title: "SourceSync.ai | Firecrawl"
og:description: "Firecrawl integrates with SourceSync.ai for web scraping capabilities."
og:description: "Firecrawl integrates with SourceSync.ai to bring clean web context into its RAG pipelines."
---

[SourceSync.ai](https://sourcesync.ai) is a Retrieval Augmented Generation as a Service platform that helps you build AI applications with your own data. This guide explains how to use Firecrawl with SourceSync.ai for web scraping capabilities.
Expand Down
2 changes: 1 addition & 1 deletion integrations/stripe-projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ stripe projects env --pull

The CLI also writes `FIRECRAWL_API_BASE_URL` and `FIRECRAWL_DOCUMENTATION_URL`. Both are informational. The SDKs read `FIRECRAWL_API_URL`, and only for self-hosted deployments; a Stripe-provisioned account uses the hosted API, which is the default, so leave `FIRECRAWL_API_URL` unset.

From here, follow the [Node.js](/quickstarts/nodejs) or [Python](/quickstarts/python) quickstart, or the [SDK overview](/sdks/overview) for other languages. The key works with every endpoint: [search](/features/search), [scrape](/features/scrape), [crawl](/features/crawl), [map](/features/map), [extract](/features/extract), [interact](/features/interact), [parse](/features/parse), and [monitor](/features/monitoring).
From here, follow the [Node.js](/quickstarts/nodejs) or [Python](/quickstarts/python) quickstart, or the [SDK overview](/sdks/overview) for other languages. The key works with every endpoint: [search](/features/search), [scrape](/features/scrape), [crawl](/features/crawl), [map](/features/map), [interact](/features/interact), [agent](/features/agent), [parse](/features/parse), and [monitor](/features/monitoring).

## Catalog

Expand Down
6 changes: 3 additions & 3 deletions introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Introduction
description: "The web data API for AI agents. Search the web, scrape any page, and interact with it through one API."
description: "The context API for AI agents. Search the web, scrape any page, and interact with it through one API."
og:title: "Introduction | Firecrawl"
og:description: "The web data API for AI agents. Search the web, scrape any page, and interact with it through one API."
og:description: "The context API for AI agents. Search the web, scrape any page, and interact with it through one API."
---

import SearchPython from "/snippets/v2/search/base/python.mdx";
Expand All @@ -26,7 +26,7 @@ import {
} from "/snippets/shared/agent-first-onboarding.jsx";
import AlexandriaFeedbackCTA from "/snippets/alexandria-feedback-cta.mdx";

Firecrawl is the web data API for AI agents. Search, scrape, and interact with the live web to get clean Markdown or structured data.
Firecrawl is the context API for AI agents. Search, scrape, and interact with the live web to get clean Markdown or structured data.

## Get started

Expand Down
2 changes: 1 addition & 1 deletion learn/rag-llama3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ from langchain_community.document_loaders import FireCrawlLoader # Importing th

url = "https://firecrawl.dev"
loader = FirecrawlLoader(
api_key="fc-YOUR_API_KEY", # Note: Replace 'YOUR_API_KEY' with your actual FireCrawl API key
api_key="fc-YOUR_API_KEY", # Note: Replace 'YOUR_API_KEY' with your actual Firecrawl API key
url=url, # Target URL to crawl
mode="crawl" # Mode set to 'crawl' to crawl all accessible subpages
)
Expand Down
4 changes: 2 additions & 2 deletions quickstarts/aspnet-core.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "ASP.NET Core"
description: "Use Firecrawl with ASP.NET Core to search, scrape, and interact with web data using the REST API."
description: "Use Firecrawl with ASP.NET Core to search, scrape, and interact with the web using the REST API."
og:title: "ASP.NET Core Quickstart | Firecrawl"
og:description: "Use Firecrawl with ASP.NET Core to search, scrape, and interact with web data using the REST API."
og:description: "Use Firecrawl with ASP.NET Core to search, scrape, and interact with the web using the REST API."
---

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion quickstarts/autogen.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Integrate Firecrawl with [Microsoft AutoGen](https://github.com/microsoft/autoge
## Setup

```bash
pip install -U "autogen-agentchat" "autogen-ext[openai]" firecrawl-py
pip install -U "autogen-agentchat" "autogen-ext[openai]" firecrawl
```

Set your keys:
Expand Down
2 changes: 1 addition & 1 deletion quickstarts/django.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ og:description: "Use Firecrawl with Django to scrape, search, and interact with
## Install the SDK

```bash
pip install firecrawl-py
pip install firecrawl
```

Add your API key to your Django settings or environment:
Expand Down
4 changes: 2 additions & 2 deletions quickstarts/express.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Express"
description: "Use Firecrawl with Express to build web scraping and search APIs."
description: "Use Firecrawl with Express to build APIs that search, scrape, and interact with the web."
og:title: "Express Quickstart | Firecrawl"
og:description: "Use Firecrawl with Express to build web scraping and search APIs."
og:description: "Use Firecrawl with Express to build APIs that search, scrape, and interact with the web."
---

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion quickstarts/fastapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ og:description: "Use Firecrawl with FastAPI to build async web scraping and sear
## Setup

```bash
pip install fastapi uvicorn firecrawl-py
pip install fastapi uvicorn firecrawl
```

Add your API key to `.env`:
Expand Down
2 changes: 1 addition & 1 deletion quickstarts/flask.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ og:description: "Use Firecrawl with Flask to build web scraping and search APIs
## Setup

```bash
pip install flask firecrawl-py
pip install flask firecrawl
```

Add your API key to `.env`:
Expand Down
4 changes: 2 additions & 2 deletions quickstarts/nestjs.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "NestJS"
description: "Use Firecrawl with NestJS to build structured web scraping and search services."
description: "Use Firecrawl with NestJS to build services that search, scrape, and interact with the web."
og:title: "NestJS Quickstart | Firecrawl"
og:description: "Use Firecrawl with NestJS to build structured web scraping and search services."
og:description: "Use Firecrawl with NestJS to build services that search, scrape, and interact with the web."
---

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion quickstarts/openclaw.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebarTitle: "OpenClaw"
icon: "lobster"
---

Integrate Firecrawl with OpenClaw to give your agents the ability to scrape, search, crawl, extract, and interact with the web — all through the [Firecrawl CLI](/sdks/cli).
Integrate Firecrawl with OpenClaw to give your agents the ability to scrape, search, crawl, and interact with the web, and run Agent jobs, all through the [Firecrawl CLI](/sdks/cli).

## Why Firecrawl + OpenClaw

Expand Down
2 changes: 1 addition & 1 deletion quickstarts/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ og:description: "Get started with Firecrawl in Python. Scrape, search, and inter
## Install the SDK

```bash
pip install firecrawl-py
pip install firecrawl
```

## Search the web
Expand Down
Loading
Loading