PRprolific
aiTaskBuilder

Create a Collection

Changed on

Create a new AI Task Builder Collection. Collections allow you to define static content and instructions without requiring a dataset upload.

Unlike Batches, Collections do not require a dataset or setup step — they can be published to a study immediately after creation.

post/api/v1/data-collection/collections

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/collections
  • Auth
    API key in header Authorization

Request body

namestring required

The name of the collection

workspace_idstring required

The ID of the Prolific workspace

Response

Created

idstring uuid required
schema_version'1' required
created_atstring date-time required

ISO-8601 formatted creation timestamp in UTC

created_bystring required

User ID of the Prolific user that created the collection

workspace_idstring required

The ID of the Prolific workspace

namestring required

The name of the collection

last_modified_atstring date-time

ISO-8601 formatted last modification timestamp in UTC

last_modified_bystring

User ID of the Prolific user that last modified the collection

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-collection removed and replaced with aiTaskBuilder_CreateCollection