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

# 快速入门

> 获取您的 API 密钥并发送第一个 /crawl 请求。

## 获取 API 密钥

从[仪表盘](https://dashboard.decodo.com/)复制您的 API 密钥，并在 `Authorization` 请求头中发送。请将以下示例中的 `TOKEN VALUE` 替换为您的密钥。

## 发起爬取

发送 `POST` 请求，并提供要爬取的 URL。响应会返回 `crawl_id`。

<CodeGroup>
  ```shellscript cURL theme={null}
  # 将 'TOKEN VALUE' 替换为您的 API 密钥
  curl --request 'POST' \
        --url 'https://data.decodo.com/v1/crawl' \
        --header 'Accept: application/json' \
        --header 'Authorization: Bearer TOKEN VALUE' \
        --header 'Content-Type: application/json' \
        --data '
      {
      "url": "https://decodo.com",
      "limit": 2,
      "max_depth": 1,
      "sitemap": "skip"
      }
  '
  ```
</CodeGroup>

响应包含 `crawl_id`、爬取状态，以及查看状态和结果的链接。

```json 响应示例 theme={null}
{
    "target": "crawl",
    "url": "https://decodo.com/",
    "created_at": "2026-10-08 07:14:45",
    "crawl_id": "{crawl_id}",
    "status": "pending",
    "crawl_status": "https://data.decodo.com/v1/crawl/{crawl_id}/status",
    "results_tasks": "https://data.decodo.com/v1/crawl/{crawl_id}",
    "results_content": "https://data.decodo.com/v1/crawl/{crawl_id}?type=content"
}
```

## 查看爬取状态

使用响应中的 `crawl_status` 链接查看爬取进度。

<CodeGroup>
  ```shellscript cURL theme={null}
  curl --request 'GET' \
        --url 'https://data.decodo.com/v1/crawl/{crawl_id}/status' \
        --header 'Accept: application/json' \
        --header 'Authorization: Bearer TOKEN VALUE'
  ```
</CodeGroup>

当 `status` 为 `done` 时，表示所有页面均已处理完毕。

```json 响应示例 theme={null}
{
    "target": "crawl",
    "url": "https://decodo.com/",
    "created_at": "2026-10-08 07:14:45",
    "crawl_id": "{crawl_id}",
    "status": "done",
    "sitemap_status": "skip",
    "output": "markdown",
    "discovered": 2,
    "completed": 2,
    "failed": 0,
    "in_flight": 0,
    "sitemaps": 0,
    "requests": 2
}
```

各字段的含义请参阅[状态、结果与取消](/docs/cn/web-data-api-crawl-status-results-cancellation)。

## 获取结果

使用 `results_content` 可在响应中直接获取已抓取的页面内容；使用 `results_tasks` 可获取所有已爬取 URL 及其状态的列表。

<Note>
  爬取完成后，结果将保存 24 小时。请在此期间内获取结果。
</Note>

<CodeGroup>
  ```shellscript cURL theme={null}
  curl --request 'GET' \
        --url 'https://data.decodo.com/v1/crawl/{crawl_id}?type=content' \
        --header 'Accept: application/json' \
        --header 'Authorization: Bearer TOKEN VALUE'
  ```
</CodeGroup>

***

<Columns cols={2}>
  <Card title="支持" href="https://direct.lc.chat/12092754" cta="让我们聊聊！">
    需要帮助或只是想打个招呼？我们的支持团队全天候为您服务。 \
    您也可以随时通过电子邮件 [support@decodo.com](mailto:support@decodo.com) 联系我们。
  </Card>

  <Card title="反馈" href="mailto:feedback@decodo.com" cta="分享反馈">
    找不到您要找的内容？请求一篇文章！ \
    有反馈意见？分享您对我们如何改进的想法。
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.