Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Create a Dataset

Create a new AI Task Builder dataset.

Pass an optional schema to create a V4 dataset with a structured schema. V4 datasets accept JSONL and CSV uploads, track each upload as an import job, and allow dataset_field items in batch_items to reference named schema fields. Without a schema, a V3 dataset is created (CSV/ZIP only, legacy flow).

V4 dataset creation requires the feature to be enabled for the workspace.

post/api/v1/data-collection/datasets

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>.

Request body

namestring required

The name or identifier of the AI Task Builder dataset.

workspace_idstring required

The ID of the Prolific workspace the dataset will be created in.

Response

Created

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.