v4
OpenAPI 3.1.02026-07-31121440441.0 KBSetup a Batch
The 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.
Path parameters
The unique identifier of the AI Task Builder batch
Headers
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
Response
Accepted
Empty response body