Setup AI Task Builder batch

The setup process creates all of the tasks within the batch according to your configuration. The dataset referenced in the requesty body must be in a READY status before the setup process can be initiated.

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.

The setup process creates all of the **tasks** within the batch according to your configuration. The dataset referenced in the requesty body must be in a **READY** status before the setup process can be initiated. 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>.

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_idstringRequired

The unique identifier of the AI Task Builder batch

Request

This endpoint expects an object.

dataset_idstringOptionalformat: "uuid"

The ID of the dataset being configured into tasks as part of the setup process.

tasks_per_groupdoubleOptional>=1Defaults to 1

The number of tasks to be presented to each annotator that provides a response.

Response

Accepted

1	import requests
2
3	url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/setup"
4
5	payload = {}
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

Authentication

Path Parameters

Request

Response

Errors