Create Batch Instructions

POST

https://api.prolific.com/api/v1/data-collection/batches/:batch_id/instructions

POST

/api/v1/data-collection/batches/:batch_id/instructions

curl -X POST https://api.prolific.com/api/v1/data-collection/batches/5f7b5e9a-3f3c-4b3e-8f1a-1a2b3c4d5e6f/instructions \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructions": [
    {
      "type": "multiple_choice",
      "description": "Choose the LLM response which is more accurate.",
      "answer_limit": 1,
      "options": [
        {
          "label": "Response 1",
          "value": "response1"
        },
        {
          "label": "Response 2",
          "value": "response2"
        }
      ]
    },
    {
      "type": "free_text",
      "description": "Please share the reasons for your choice.",
      "placeholder_text_input": "e.g. I chose this response because..."
    },
    {
      "type": "multiple_choice_with_free_text",
      "description": "Rate each aspect and explain your reasoning.",
      "answer_limit": -1,
      "options": [
        {
          "label": "Good",
          "value": "accuracy_good",
          "heading": "Accuracy"
        },
        {
          "label": "Needs improvement",
          "value": "accuracy_poor",
          "heading": "Accuracy"
        }
      ]
    },
    {
      "type": "free_text_with_unit",
      "description": "What is your height?",
      "unit_options": [
        {
          "label": "Centimeters",
          "value": "cm",
          "validation": {
            "type": "number",
            "min": 50,
            "max": 300
          }
        },
        {
          "label": "Feet",
          "value": "ft",
          "validation": {
            "type": "number",
            "min": 1,
            "max": 9
          }
        }
      ],
      "unit_position": "suffix"
    },
    {
      "type": "file_upload",
      "description": "Upload a photo of the item",
      "accepted_file_types": [
        ".jpg",
        ".jpeg",
        ".png"
      ],
      "max_file_size_mb": 10,
      "min_file_count": 1,
      "max_file_count": 3
    }
  ]
}'

[
  {
    "type": "multiple_choice",
    "answer_limit": 1,
    "created_at": "2024-09-18T07:50:15.055Z",
    "created_by": "Sean",
    "description": "Choose the LLM response which is more accurate.",
    "id": "0192041c-470f-7336-8e3d-e03fc086a4e1",
    "options": [
      {
        "label": "Response 1",
        "value": "response1"
      },
      {
        "label": "Response 2",
        "value": "response2"
      }
    ],
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch"
  },
  {
    "type": "free_text",
    "created_at": "2024-09-18T07:50:15.056Z",
    "created_by": "Sean",
    "description": "Please share the reasons for your choice.",
    "id": "0192041c-4710-7336-8e3d-e9b6149c0797",
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch"
  },
  {
    "type": "multiple_choice_with_free_text",
    "answer_limit": -1,
    "created_at": "2024-09-18T07:50:15.057Z",
    "created_by": "Sean",
    "description": "Rate each aspect and explain your reasoning.",
    "id": "0192041c-4712-7336-8e3d-a2b3c4d5e6f7",
    "options": [
      {
        "label": "Good",
        "value": "accuracy_good",
        "heading": "Accuracy"
      },
      {
        "label": "Needs improvement",
        "value": "accuracy_poor",
        "heading": "Accuracy"
      }
    ],
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch"
  },
  {
    "type": "free_text_with_unit",
    "created_at": "2024-09-18T07:50:15.058Z",
    "created_by": "Sean",
    "description": "What is your height?",
    "id": "0192041c-4713-7336-8e3d-b3c4d5e6f7a8",
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch",
    "unit_options": [
      {
        "label": "Centimeters",
        "value": "cm",
        "validation": {
          "type": "number",
          "min": 50,
          "max": 300
        }
      },
      {
        "label": "Feet",
        "value": "ft",
        "validation": {
          "type": "number",
          "min": 1,
          "max": 9
        }
      }
    ],
    "unit_position": "suffix"
  },
  {
    "type": "file_upload",
    "created_at": "2024-09-18T07:50:15.059Z",
    "created_by": "Sean",
    "description": "Upload a photo of the item",
    "id": "0192041c-4711-7336-8e3d-f1c7260d1898",
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch",
    "accepted_file_types": [
      ".jpg",
      ".jpeg",
      ".png"
    ],
    "max_file_count": 3,
    "max_file_size_mb": 10,
    "min_file_count": 1
  }
]

Create instructions for a Task Builder batch.

Important

Deprecated for batches that use batch_items.

All responses include the RFC 8594 headers Deprecation: true and Sunset: Tue, 01 Sep 2026 23:59:59 GMT.

If the target batch was created with batch_items (the per-item instructions flow), this endpoint will respond with 422 Unprocessable Entity and an error message directing you to manage instructions via the batch_items payload instead.

Legacy batches (where batch_items is null) continue to work and return 201 Created.

Authentication

AuthorizationToken

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>.

Path parameters

batch_idstringRequired

The unique identifier of the AI Task Builder batch

Request

This endpoint expects an object.

instructionslist of objectsRequired

The instructions to create for the AI Task Builder batch.

Response headers

DeprecationstringOptional

Per RFC 8594, signals that this endpoint is deprecated.

SunsetstringOptional

Per RFC 8594, the date after which this endpoint will no longer be supported.

Response

Created. Returned only for legacy batches (batch_items is null).

multiple_choiceobject

free_textobject

free_text_with_unitobject

multiple_choice_with_free_textobject

file_uploadobject

Errors

4XX

Client Request Error

422

Unprocessable Entity Error