Update Batch Instructions

import requests
url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/instructions"
payload = { "instructions": [
        {
            "type": "multiple_choice",
            "description": "Choose the LLM response which is more accurate.",
            "id": "0192041c-470f-7336-8e3d-e03fc086a4e1",
            "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.",
            "id": "0192041c-4710-7336-8e3d-e9b6149c0797"
        },
        {
            "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.put(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."
  }
]

Updates the instructions for a task builder batch. This is a full replacement - all instructions must be included in the request.

Include the id field for existing instructions you want to preserve. Instructions without an id will be created as new.

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

Batch ID

Request

This endpoint expects an object.

instructionslist of objectsRequired

The instructions for the batch.

Response

Updated

multiple_choiceobject

free_textobject

multiple_choice_with_free_textobject

file_uploadobject

Authentication

Path parameters

Request

Response

Errors