PRprolific
aiTaskBuilder

Create a Dataset

Changed on

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

Request

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

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.

Changes

  • d0e32ae96e4eRevision changes
    • info

      added the new optional request property ///

    • 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