Get a Dataset

GET

https://api.prolific.com/api/v1/data-collection/datasets/:dataset_id

GET

/api/v1/data-collection/datasets/:dataset_id

curl https://api.prolific.com/api/v1/data-collection/datasets/0192a3b5-e8f9-7a0b-1c2d-3e4f5a6b7c8d \
     -H "Authorization: Token <token>"

{
  "id": "string",
  "name": "Text Dataset",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "65786062db3b35bcbeb07bcc",
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "total_datapoint_count": 1,
  "schema_version": 3,
  "status": "ERROR",
  "filename": "string",
  "has_predetermined_grouping_id": true,
  "schema": {
    "strict": true,
    "fields": {}
  },
  "imports": [
    {
      "dataset_id": "string",
      "import_id": "string",
      "type": "file_upload",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "status": "uninitialised",
      "filename": "string",
      "accepted_count": 1,
      "rejected_count": 1,
      "errors": [
        {
          "record_index": 1,
          "field": "string",
          "reason": "string"
        }
      ],
      "reason": "string"
    }
  ]
}

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.

Authentication

AuthorizationToken

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

Path parameters

dataset_idstringRequired

The unique identifier of the AI Task Builder dataset

Response

idstringformat: "uuid"

namestring

created_atdatetime

created_bystring

workspace_idstring

total_datapoint_countinteger>=0

schema_versionenum

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

Allowed values:

statusenumOptional

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

Allowed values:

filenamestring or nullOptional

Filename of the uploaded data file. V3 datasets only.

has_predetermined_grouping_idboolean or nullOptional

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

schemaobject or nullOptional

The researcher-defined field schema for this dataset. V4 datasets only. null if no schema has been set yet.

importslist of objects or nullOptional

Import jobs for this dataset, most recent first. V4 datasets only. null for V3 datasets.

Errors

4XX

Client Request Error

404

Not Found Error