Skip to navigation

Get Batch Status

View as MarkdownOpen in Claude
Get the current status of an AI Task Builder batch.

Authentication

AuthorizationToken

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

OK
statusenumOptional

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

Allowed values:

Errors

4XX
Client Request Error