Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Duplicate a Batch

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

post/api/v1/data-collection/batches/{batch_id}/duplicate

Path parameters

batch_idstring required

The unique identifier of the batch to duplicate

Headers

Authorizationstring required

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

Request body

namestring

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

upload_new_datasetboolean

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

idstring uuid required
created_atstring date-time required

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

created_bystring required

User ID of the Prolific user that created the resource.

namestring required
status'UNINITIALISED' | 'PROCESSING' | 'READY' | 'ERROR' required
total_task_countinteger required
total_instruction_countinteger required
workspace_idstring required