v4

OpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Create a Collection

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

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

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