v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Get a Dataset

Get a specific AI Task Builder dataset by its unique identifier.

For V4 datasets, the response includes the dataset schema (if one has been set) and an imports array listing all import jobs for this dataset.

For V3 datasets, the response includes status, filename, and has_predetermined_grouping_id instead.

get/api/v1/data-collection/datasets/{dataset_id}

Path parameters

dataset_idstring required

The unique identifier of the AI Task Builder dataset

Headers

Authorizationstring required

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Response

OK

idstring uuid required
namestring required
created_atstring date-time required
created_bystring required
workspace_idstring required
total_datapoint_countinteger required
schema_version'3' | '4' required

Internal dataset version. 3 = legacy CSV/ZIP; 4 = structured schema with JSONL/CSV import tracking.

status'ERROR' | 'PROCESSING' | 'READY' | 'UNINITIALISED'

Processing status. V3 datasets only. V4 datasets track status per import job via imports.

filenamestring nullable

Filename of the uploaded data file. V3 datasets only.

has_predetermined_grouping_idboolean nullable

Whether the dataset contains a META_TASK_GROUP_ID column. V3 datasets only.