Setup a Batch
Changed onThe setup process creates all of the tasks within the batch according to your configuration. Each datapoint in the dataset is paired with all instructions to create a task. Tasks are then organized into task groups.
V3 datasets: The dataset must be in a READY status before setup can be initiated.
V4 datasets: The dataset must have at least one import job with status complete. V4 datasets do not have a READY status — readiness is determined per import job via GET /datasets/{dataset_id}/imports/{import_id}.
The dataset can be attached either at batch creation time or via the dataset_id parameter in this request.
Upon successful invocation, the setup process will begin asynchronously, and the batch will be set to a PROCESSING status.
To retrieve the status of the setup, call the GET /api/v1/data-collection/batches/{batch_id}/status endpoint. The setup is complete once the batch status changes to READY.
Request
- Base URLhttps://api.prolific.com
- URLhttps://api.prolific.com/api/v1/data-collection/batches/{batch_id}/setup
- AuthAPI key in header Authorization
Path parameters
The unique identifier of the AI Task Builder batch
Request body
Response
Accepted
Empty response body
Changes
- warning
deleted the
headerrequest parameterAuthorization - info
the endpoint scheme security
tokenwas added to the API
- warning
- info
api operation id
setup-task-builder-batchremoved and replaced withaiTaskBuilder_SetupTaskBuilderBatch
- info