v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB

aiTaskBuilder

Create Batch Instructions

Create instructions for a Task Builder batch.

Deprecated for batches that use batch_items.

All responses include the RFC 8594 headers Deprecation: true and Sunset: Tue, 01 Sep 2026 23:59:59 GMT.

If the target batch was created with batch_items (the per-item instructions flow), this endpoint will respond with 422 Unprocessable Entity and an error message directing you to manage instructions via the batch_items payload instead.

Legacy batches (where batch_items is null) continue to work and return 201 Created.

</Error>

post/api/v1/data-collection/batches/{batch_id}/instructions

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

Request body

Response

Created. Returned only for legacy batches (batch_items is null).