Duplicate a Batch | Prolific API

curl -X POST https://api.prolific.com/api/v1/data-collection/batches/batch_id/duplicate \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "d9f8e7c6-b5a4-3210-9876-54321fedcba0",
      "total_datapoint_count": 1500
    }
  ],
  "name": "Customer Feedback Analysis Batch",
  "status": "UNINITIALISED",
  "total_task_count": 5,
  "total_instruction_count": 3,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "task_details": {
    "task_name": "Sentiment Classification",
    "task_introduction": "Classify customer feedback into positive, neutral, or negative sentiments.",
    "task_steps": "1. Read the feedback text. 2. Determine the sentiment category. 3. Submit the classification."
  }
}

Create a duplicate of an existing AI Task Builder batch. The dataset does not need to be in READY status for duplication. Supports two modes:

Duplicate with dataset (default): Creates a copy with the same dataset (the dataset is shared between both batches, not duplicated)
Duplicate without dataset: Creates a copy that requires a new dataset upload (set upload_new_dataset to true)

You can optionally provide a new name for the duplicated batch. If no name is provided, the duplicate will be named “[Original Batch Name] (Copy)”.

Create a duplicate of an existing AI Task Builder batch. The dataset does not need to be in READY status for duplication. Supports two modes: - Duplicate with dataset (default): Creates a copy with the same dataset (the dataset is shared between both batches, not duplicated) - Duplicate without dataset: Creates a copy that requires a new dataset upload (set upload_new_dataset to true) You can optionally provide a new name for the duplicated batch. If no name is provided, the duplicate will be named "[Original Batch Name] (Copy)".

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

batch_idstringRequired

The unique identifier of the batch to duplicate

Request

This endpoint expects an object.

namestringOptional

Optional name for the duplicated batch. If not provided, a default name will be generated.

upload_new_datasetbooleanOptionalDefaults to false

If true, creates the batch without copying the dataset (user must upload a new one). If false or omitted, duplicates with the existing dataset.

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

Path parameters

Request

Response

Errors