Setup 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.
The dataset must be in a **READY** status before the setup process can be initiated. 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**.
Authentication
Authorizationstring
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_id
The unique identifier of the AI Task Builder batch
Request
This endpoint expects an object.
dataset_id
The ID of the dataset to use for task generation. Optional if a dataset was already attached at batch creation time.
tasks_per_group
The number of tasks to randomly assign to each task group. Participants complete one task group per submission. If your dataset includes a META_TASK_GROUP_ID column, those groupings take precedence over this parameter.
Response
Accepted
