自定义输入

了解如何向输入架构添加自定义字段，以实现增强的数据管理和检索。

POST /datasets/v3/scrape

Scrape data and return it directly in the response.

cURL

curl --request POST \
  --url https://api.brightdata.com/datasets/v3/scrape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_input_fields": [
    "url",
    "prompt",
    "index_custom"
  ],
  "input": [
    {
      "url": "https://chatgpt.com/",
      "prompt": "Top hotels in New York",
      "index_custom": "abd45424"
    }
  ]
}
'

200

"OK"

自定义输入

您可以向输入架构添加自定义字段，无论您在这些字段中发送什么内容，都将在结果中返回给每个记录/任务。这对以下场景很有用：

• 统一架构：在不同的爬虫器/数据集中保持相同的输出结构。
• 索引/参考字段：传递 id、row_index 或任何内部密钥，以便您可以轻松将结果匹配回原始输入行。

Authorizations

Authorization · string · header · required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
2. Include the API Key in the Authorization header of your requests
3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Query Parameters

dataset_id · string · required

Dataset ID for which data collection is triggered.

custom_output_fields · string

List of output columns, separated by | (e.g., url|about.updated_on). Filters the response to include only the specified fields.

Example:

"url|about.updated_on"

include_errors · boolean

Include errors report with the results.

format · enum<string> · default: json

Specifies the format of the response (default: ndjson).

Available options: ndjson, json, csv

Body

application/json

input · object[] · required

List of input items to scrape.

Show child attributes

Example:

[
  {
    "url": "https://chatgpt.com/",
    "prompt": "Top hotels in New York",
    "index_custom": "abd45424"
  }
]

custom_input_fields · string[]

List of custom input field names whose values are passed through and returned unchanged in the results for each record.

The name of a custom input field to be accepted and returned in the results.

Example:

["url", "prompt", "index_custom"]

custom_output_fields · string

List of output columns, separated by | (e.g., url|about.updated_on). Filters the response to include only the specified fields.

Example:

"url|about.updated_on"

Response

200

text/plain

OK

The response is of type string.

Example:

"OK"