Sign in

v4

OpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Get a Batch

Get a specific AI Task Builder batch by its unique identifier.

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

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

idstring uuid required
created_atstring date-time required

An ISO-8601 formatted string representing the batch creation time, in UTC.

created_bystring required

User ID of the Prolific user that created the resource.

namestring required
status'UNINITIALISED' | 'PROCESSING' | 'READY' | 'ERROR' required
total_task_countinteger required
total_instruction_countinteger required
workspace_idstring required
schema_versioninteger required
total_task_groupsinteger required
auto_sync_enabledboolean

When true, datapoints appended to the batch's attached dataset automatically trigger a sync that materialises tasks for them. Optional — absent on batches that have never enabled auto-sync. Absent or false mean auto-sync is off.