Get AI Task Builder batch status

Get the current status of an AI Task Builder batch.

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

Response

statusenum or null

The status of the Batch - one of ‘UNINITIALISED’, ‘PROCESSING’, ‘READY’, ‘ERROR’

Allowed values:

1	import requests
2
3	url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/status"
4
5	headers = {"Authorization": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

Authentication

Path Parameters

Response

Errors