aiTaskBuilder

The setup process creates all of the tasks within the batch according to your configuration. Each datapoint in the dataset is paired with all instructions to create a task. Tasks are then organized into task groups.

V3 datasets: The dataset must be in a READY status before setup can be initiated.

V4 datasets: The dataset must have at least one import job with status complete. V4 datasets do not have a READY status — readiness is determined per import job via GET /datasets/{dataset_id}/imports/{import_id}.

The dataset can be attached either at batch creation time or via the dataset_id parameter in this request.

Upon successful invocation, the setup process will begin asynchronously, and the batch will be set to a PROCESSING status.

To retrieve the status of the setup, call the GET /api/v1/data-collection/batches/{batch_id}/status endpoint. The setup is complete once the batch status changes to READY.

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

Request

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

Path parameters

batch_idstring required

The unique identifier of the AI Task Builder batch

Request body

dataset_idstring uuid

The ID of the dataset to use for task generation. Optional if a dataset was already attached at batch creation time.

tasks_per_groupinteger

The number of tasks to randomly assign to each task group. Participants complete one task group per submission. If your dataset includes a META_TASK_GROUP_ID column, those groupings take precedence over this parameter.

Response

Accepted

AITaskBuilderSetupTaskBuilderBatchResponse202 required

Empty response body

Changes

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

    • info

      api operation id setup-task-builder-batch removed and replaced with aiTaskBuilder_SetupTaskBuilderBatch