Create Batch 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": "file_upload",
      "description": "Upload a photo of the item"
    }
  ]
}'

[
  {
    "id": "0192041c-470f-7336-8e3d-e03fc086a4e1",
    "created_at": "2024-09-18T07:50:15.055Z",
    "type": "multiple_choice",
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch",
    "created_by": "Sean",
    "description": "Choose the LLM response which is more accurate.",
    "answer_limit": 1,
    "options": [
      {
        "label": "Response 1",
        "value": "response1"
      },
      {
        "label": "Response 2",
        "value": "response2"
      }
    ]
  },
  {
    "id": "0192041c-4710-7336-8e3d-e9b6149c0797",
    "created_at": "2024-09-18T07:50:15.056Z",
    "type": "free_text",
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch",
    "created_by": "Sean",
    "description": "Please share the reasons for your choice."
  },
  {
    "id": "0192041c-4711-7336-8e3d-f1c7260d1898",
    "created_at": "2024-09-18T07:50:15.057Z",
    "type": "file_upload",
    "parent_id": "01974850-9e29-744a-811c-b26612812345",
    "parent_type": "batch",
    "created_by": "Sean",
    "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
  }
]

Create instructions for a Task Builder batch.

Authentication

AuthorizationToken

Header authentication of the form Token <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

Created

multiple_choiceobject

free_textobject

free_text_with_unitobject

multiple_choice_with_free_textobject

file_uploadobject

Authentication

Path parameters

Request

Response

Errors