Skip to main content
POST
cURL
You need a Snapshot ID to use this endpoint. A Snapshot ID (e.g., snap_m2bxug4e2o352v1jv1) is a unique identifier created each time a data collection is triggered or a dataset is filtered.

Where do Snapshot IDs come from?

If you don’t have a Snapshot ID yet, start by filtering a dataset Filter Dataset or triggering a collection first. The response will include the snapshot_id you need.
You can check snapshot status before delivering:
The snapshot must be in ready status before delivery.
See Get Snapshot Metadata for full documentation.
The id returned in the response is a delivery job ID. Use it to monitor whether your delivery has completed, failed, or been canceled.
Poll this endpoint until status is “done”. For large snapshots with batch_size set, delivery_files will contain multiple entries, one per batch file.
See Monitor Delivery for full documentation.
Here’s the complete flow from triggering a collection to receiving your data:
1

Trigger a collection or filter a dataset

This creates a snapshot and returns a snapshot_id.
2

Wait for the snapshot to be ready

Poll the snapshot metadata endpoint until status is “ready”.
3

Deliver the snapshot

Call this endpoint with the snapshot ID and your delivery configuration.
4

Track the delivery

Use the delivery job ID to monitor progress.

Snapshot retention

A snapshot can be delivered only while it is within the retention period. Dataset snapshots are available for 14 days after they are generated. After this period, the snapshot expires and can no longer be delivered. To deliver the data after expiration, create a new snapshot for the same dataset.

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:

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

Path Parameters

id
string
required

The Snapshot ID to deliver. This is the unique identifier returned when you trigger a collection, filter a dataset, or run a subscription.

Learn more about Snapshot ID.

Example:

"snap_m2bxug4e2o352v1jv1"

Body

application/json
deliver
Microsoft Azure · object

Deliver configuration

compress
boolean
default:false

Deliver file compressed in gzip format

batch_size
integer

Number of records per file. Use this to split large snapshots into multiple smaller files. Files are split by record count. Recommended for snapshots with more than 1 million records. Note: Maximum batch size is 5GB.

Example:

100000

Response

OK

id
string

The delivery job ID. Use this ID to track the delivery status (see Tracking delivery status).