PRprolific
aiTaskBuilder

Get a Dataset

Changed on

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}

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/datasets/{dataset_id}
  • Auth
    API key in header Authorization

Path parameters

dataset_idstring required

The unique identifier of the AI Task Builder dataset

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.

Changes

  • d0e32ae96e4eRevision changes
    • info

      added the optional property //// to the response with the status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API