v4

OpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Get Batch Status

Get the current status of an AI Task Builder batch.

get/api/v1/data-collection/batches/{batch_id}/status

Path parameters

batch_idstring required

The unique identifier of the AI Task Builder batch

Headers

Authorizationstring required

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>.

Response

OK

status'UNINITIALISED' | 'PROCESSING' | 'READY' | 'ERROR'

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