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

# 简介

> Firecrawl API 参考

<div id="features">
  ## 功能
</div>

<CardGroup cols={3}>
  <Card title="Scrape" icon="markdown" href="/zh/api-reference/endpoint/scrape" color="FF713C">
    以 markdown 或 json 格式从任意网页提取内容。
  </Card>

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

  <Card title="Map" icon="map" href="/zh/api-reference/endpoint/map" color="FF713C">
    快速、稳定地获取任意网站的完整 URL 列表。
  </Card>

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

<div id="agentic-features">
  ## 代理特性
</div>

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

<div id="base-url">
  ## 基础 URL
</div>

所有请求使用以下基础 URL：

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

<div id="authentication">
  ## 身份验证
</div>

进行身份验证时，需要在请求中包含 Authorization 头。其值应为 `Bearer fc-123456789`，其中 `fc-123456789` 是你的 API 密钥。

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

​

<div id="response-codes">
  ## 响应代码
</div>

Firecrawl 使用常规 HTTP 状态码来表示请求结果。

通常，2xx 表示成功，4xx 表示与用户相关的错误，5xx 表示基础设施问题。

| Status | Description          |
| ------ | -------------------- |
| 200    | 请求成功。                |
| 400    | 请检查参数是否正确。           |
| 401    | 未提供 API key。         |
| 402    | 需要付款。                |
| 404    | 找不到请求的资源。            |
| 429    | 超出速率限制。              |
| 5xx    | 表示 Firecrawl 的服务器错误。 |

请参阅“错误代码”部分，了解所有可能的 API 错误的详细说明。

<div id="rate-limit">
  ## 速率限制
</div>

Firecrawl API 设有速率限制，以确保服务的稳定性和可靠性。该限制适用于所有端点，按特定时间窗口内的请求次数计量。

当你超出速率限制时，将会收到 429 状态码。