Create Batch Instructions

import requests
url = "https://api.prolific.com/api/v1/data-collection/batches/5f7b5e9a-3f3c-4b3e-8f1a-1a2b3c4d5e6f/instructions"
payload = { "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"
                }
            ]
        }
    ] }
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

[
  {
    "id": "0192041c-470f-7336-8e3d-e03fc086a4e1",
    "created_at": "2024-09-18T07:50:15.055Z",
    "type": "multiple_choice",
    "batch_id": "01974850-9e29-744a-811c-b26612812345",
    "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",
    "batch_id": "01974850-9e29-744a-811c-b26612812345",
    "created_by": "Sean",
    "description": "Please share the reasons for your choice."
  }
]

Create instructions for a Task Builder batch.

Authentication

Authorizationstring

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

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

Created

multiple_choiceobject

free_textobject

multiple_choice_with_free_textobject

file_uploadobject

Authentication

Path parameters

Request

Response

Errors