Skip to main content
POST
cURL
相关指南: 爬取 API 简介

授权

Authorization
string
header
必填

在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。

认证方法:

  1. 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
  2. 在请求的 Authorization 头中包含 API Key
  3. 格式: Authorization: Bearer YOUR_API_KEY

示例:

了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key?

查询参数

dataset_id
string
必填

您的 dataset ID。

示例:

"gd_m6gjtfmeh43we6cqc"

include_errors
boolean

在结果中包含错误报告。若将 "include_errors" 设置为 true,您将收到有关数据收集过程中发生的所有错误的详细报告。

示例:

true

custom_output_fields
string

"custom_output_fields" 参数用于筛选响应数据,仅返回指定字段。您可以使用竖线 (|) 分隔所需的输出列。

例如,如果您只想在响应中包含 URL 和上次更新日期,可以将参数设置为 "url|about.updated_on"。这允许您根据需求自定义返回的数据字段。

示例:

"url|about.updated_on"

请求体

您可以使用 JSON 或 CSV 格式提供输入数据。输入内容指定抓取器所需的 URL 或其他参数。

{key}
any

属性依据 dataset 的需求而变化。最常见的是 'url' 字段。 示例:[{"url":"https://www.airbnb.com/rooms/50122531"},{"url":"https://www.airbnb.com/rooms/50127677"}]

示例:

响应

任务已成功启动。

snapshot_id
string

Snapshot ID 是用于识别特定数据快照的唯一标识符,可用于获取通过 API 触发的抓取任务的结果。了解更多:Snapshot ID

示例:

"s_m4x7enmven8djfqak"