PRprolific
aiTaskBuilder

Duplicate a Batch

Changed on

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

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/batches/{batch_id}/duplicate
  • Auth
    API key in header Authorization

Path parameters

batch_idstring required

The unique identifier of the batch to duplicate

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

Changes

  • 9449de4ad274Revision changes
    • breaking

      added subschema #9 to the /////// response property oneOf list for the response status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API