Duplicate a Batch

POST

https://api.prolific.com/api/v1/data-collection/batches/:batch_id/duplicate

POST

/api/v1/data-collection/batches/:batch_id/duplicate

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": "a3f8c2d1-7b4e-4f9a-8c6d-2e1b5a9f3c7d",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "d7e2a1b4-3c9f-4e8d-b5a2-1f6c8e4d9b3a",
      "total_datapoint_count": 250
    }
  ],
  "name": "Product Sentiment Analysis Batch (Copy)",
  "status": "READY",
  "total_task_count": 250,
  "total_instruction_count": 4,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "task_details": {
    "task_name": "Product Review Sentiment Labelling",
    "task_introduction": "<p>In this task, you will be asked to evaluate customer product reviews and label their sentiment.</p>",
    "task_steps": "<ol><li>Read the product review carefully.</li><li>Select the sentiment that best describes the review.</li><li>Provide a brief justification for your choice.</li></ol>"
  },
  "batch_items": [
    {
      "rows": [
        {
          "columns": [
            {
              "items": [
                {
                  "type": "dataset_field",
                  "field": "review_text"
                }
              ],
              "id": "c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f"
            }
          ],
          "id": "r1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c"
        }
      ],
      "id": "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
      "display_position": "intro"
    }
  ]
}

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

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

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

batch_itemslist of objects or nullOptional

The persisted batch_items layout, returned only when batch_items was supplied on create. Every page, row, column, and item is returned with a server-assigned id.

Errors

4XX

Client Request Error