Create a Batch | Prolific API

import requests
url = "https://api.prolific.com/api/v1/data-collection/batches"
payload = {
    "name": "Sentiment Analysis Batch",
    "workspace_id": "6278acb09062db3b35bcbeb0",
    "task_details": {
        "task_name": "Evaluate Product Reviews",
        "task_introduction": "<p>In this task, you will analyze product reviews and categorize their sentiment.</p>",
        "task_steps": "<ol><li>Read each review carefully</li><li>Select the appropriate sentiment</li><li>Provide a brief explanation</li></ol>"
    },
    "dataset_id": "1234acb09999db4b99bcded1"
}
headers = {
    "Authorization": "Token <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Create a new AI Task Builder batch. The dataset does not need to be in READY status at creation time.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Request

This endpoint expects an object.

namestringRequired

The name of the batch

workspace_idstringRequired

The ID of the Prolific workspace

task_detailsobjectRequired

Task metadata displayed to participants

dataset_idstringOptional

The ID of the dataset to attach (optional at creation time)

Response

Created

idstringformat: "uuid"

created_atdatetime

An ISO-8601 formatted string representing the batch creation time, in UTC.

created_bystring

User ID of the Prolific user that created the resource.

datasetslist of objects

namestring

statusenum

Allowed values:

total_task_countinteger>=0

total_instruction_countinteger>=0

workspace_idstring

task_detailsobject

Authentication

Request

Response

Errors