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

# 介绍

> Firecrawl API 参考

## 功能

<CardGroup cols={2}>
  <Card title="抓取" icon="markdown" href="/api-reference/endpoint/scrape" color="FF713C">
    从任何网页中提取内容，格式为markdown或json。
  </Card>

  <Card title="爬取" icon="spider" href="/api-reference/endpoint/crawl-post" color="FF713C">
    爬取整个网站，提取其内容和元数据。
  </Card>

  <Card title="地图" icon="map" href="/api-reference/endpoint/map" color="FF713C">
    快速且可靠地获取任何网站的完整URL列表。
  </Card>

  <Card title="提取" icon="barcode-read" href="/api-reference/endpoint/extract" color="FF713C">
    使用自然语言从整个网页中提取结构化数据。
  </Card>

  <Card title="搜索" icon="magnifying-glass" href="/api-reference/endpoint/search" color="FF713C">
    搜索网络并以任何格式获取完整页面内容。
  </Card>
</CardGroup>

## 基本URL

所有请求都包含以下基本URL：

```bash theme={null}
https://api.firecrawl.dev 
```

## 认证

需要包含一个Authorization头来进行认证。该头应包含`Bearer fc-123456789`，其中`fc-123456789`代表您的API密钥。

```bash theme={null}
Authorization: Bearer fc-123456789
```

​

## 响应代码

Firecrawl使用常规的HTTP状态码来表示请求的结果。
通常，2xx HTTP状态码表示成功，4xx代码表示与用户相关的失败，而5xx代码表示基础设施问题。

| 状态  | 描述                |
| --- | ----------------- |
| 200 | 请求成功。             |
| 400 | 验证参数的正确性。         |
| 401 | 未提供API密钥。         |
| 402 | 需要支付费用。           |
| 404 | 找不到请求的资源。         |
| 429 | 超过了速率限制。          |
| 5xx | 表示Firecrawl服务器错误。 |

请参阅错误代码部分以获取所有潜在API错误的详细解释。

## 速率限制

Firecrawl API设有速率限制，以确保服务的稳定性和可靠性。速率限制适用于所有端点，基于在特定时间框架内进行的请求数量。
当您超过速率限制时，将收到429响应代码。