Download the processed dataset

datasets.download(, ) -> DatasetDownloadResponse

GET/api/v1/datasets/{dataset_id}/download

Streams the processed rows in the requested file format. Works on datasets with status ready (full output) and also on datasets with status failed — in the failed case the stream contains only the rows that were successfully processed before the run aborted, which is useful for recovering partial output from interrupted jobs. Returns 422 only when no run has ever started on this dataset.

Image columns (JSON / JSONL): Rows may include original_image only when the mapped image column is also in configured_column_mapping.context. Read image_column_formats from GET /datasets/{dataset_id} and look up the active image column to determine encoding: embedded_bytes → { bytes, path: null } with base64 bytes; url or file_reference → presigned HTTPS URL string. When images are not surfaced, original_image is omitted and internal s3:// URIs are never returned. See schema ProcessedDatasetExportOriginalImageFieldDto. In CSV and Parquet, embedded bytes appear as a JSON string in the cell.

ParametersExpand Collapse

dataset_id: str

file_format: Optional[Literal["csv", "json", "jsonl", "parquet"]]

Output file format. Defaults to the original upload format if omitted.

One of the following:

"csv"

"json"

"jsonl"

"parquet"

ReturnsExpand Collapse

object

Download the processed dataset

import os
from adaption import Adaption

client = Adaption(
    api_key=os.environ.get("ADAPTION_API_KEY"),  # This is the default and can be omitted
)
response = client.datasets.download(
    dataset_id="dataset_id",
)
print(response)

"Example data"

Returns Examples

"Example data"