PRprolific
aiTaskBuilder

Create Batch Instructions

Changed on

Create instructions for a Task Builder batch.

<Error title="Important">

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

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/batches/{batch_id}/instructions
  • Auth
    API key in header Authorization

Path parameters

batch_idstring required

The unique identifier of the AI Task Builder batch

Request body

Response

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

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id create-task-builder-instructions removed and replaced with aiTaskBuilder_CreateTaskBuilderInstructions