Create a Collection | Prolific API

curl -X POST https://api.prolific.com/api/v1/data-collection/collections \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Skin Type Assessment",
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "task_details": {
    "task_name": "Assess Your Skin Type",
    "task_introduction": "<p>Please answer the following questions about your skin.</p>",
    "task_steps": "<ol><li>Read each question carefully</li><li>Select the most accurate answer</li></ol>"
  },
  "collection_items": [
    {
      "page_items": [
        {
          "type": "rich_text",
          "content": "## Section 1: Basic Information"
        },
        {
          "type": "multiple_choice",
          "content": "What is your skin type? Select the option that best describes your skin condition throughout the day."
        }
      ]
    },
    {
      "page_items": [
        {
          "type": "multiple_choice",
          "content": "What is your skin type?"
        }
      ]
    },
    {
      "page_items": [
        {
          "type": "multiple_choice",
          "content": "What is your skin type?"
        }
      ]
    }
  ]
}'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "schema_version": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "user_987654321",
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "name": "Skin Type Assessment",
  "task_details": {
    "task_name": "Assess Your Skin Type",
    "task_introduction": "<p>Please answer the following questions about your skin.</p>",
    "task_steps": "<ol><li>Read each question carefully</li><li>Select the most accurate answer</li></ol>"
  },
  "collection_items": [
    {
      "id": "page_1234567890abcdef",
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "user_987654321",
      "schema_version": 1,
      "page_items": [
        {
          "id": "item_abcdef1234567890",
          "created_at": "2024-01-15T09:30:00Z",
          "type": "rich_text",
          "collection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "created_by": "user_987654321",
          "description": "Section header for basic information",
          "order": 0,
          "answer_limit": 0,
          "disable_dropdown": false,
          "options": []
        },
        {
          "id": "item_123456abcdef7890",
          "created_at": "2024-01-15T09:30:00Z",
          "type": "multiple_choice",
          "collection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "created_by": "user_987654321",
          "description": "What is your skin type?",
          "order": 1,
          "answer_limit": 1,
          "disable_dropdown": false,
          "options": [
            {
              "label": "Oily",
              "value": "oily"
            },
            {
              "label": "Dry",
              "value": "dry"
            },
            {
              "label": "Combination",
              "value": "combination"
            }
          ]
        }
      ]
    }
  ],
  "last_modified_at": "2024-01-15T09:30:00Z",
  "last_modified_by": "user_987654321"
}

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.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Request

This endpoint expects an object.

namestringRequired

The name of the collection

workspace_idstringRequired

The ID of the Prolific workspace

task_detailsobjectRequired

Task metadata displayed to participants

collection_itemslist of objectsRequired

Pages within the collection

Response

Created

idstringformat: "uuid"

schema_versionenum

Allowed values:

created_atdatetime

ISO-8601 formatted creation timestamp in UTC

created_bystring

User ID of the Prolific user that created the collection

workspace_idstring

The ID of the Prolific workspace

namestring

The name of the collection

task_detailsobject

Task metadata displayed to participants

collection_itemslist of objects

Pages within the collection. Each collection item represents a page.

last_modified_atdatetime or null

ISO-8601 formatted last modification timestamp in UTC

last_modified_bystring or null

User ID of the Prolific user that last modified the collection

Authentication

Request

Response

Errors