API ReferenceAI Task Builder

Batches

View as MarkdownOpen in Claude

A batch is the top level AI Task Builder concept that links all other entities together in a single workflow. It begins with the creation of a batch and uploading a dataset and culminates in annotators completing responses to tasks.

Important Attributes

workspace_id

  • The ID of the Prolific workspace the batch will be created in.

name

  • The name or identifier of the AI Task Builder batch.

total_task_count

  • The total number of tasks created for this batch. This represents the number of individual tasks that will be distributed to annotators.

status

  • The current status of the batch. It can transition through the following states:
    • UNINITIALISED- This means that the batch has been created, but contains no tasks.
    • PROCESSING- This means that the batch is being processed into tasks.
    • READY- This means that the batch is processed and ready to be attached to a Prolific study.
    • ERROR- This means that something has gone wrong and the data may not be usable.