Update Task Builder Instructions

1 import requests 2 3 url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/instructions" 4 5 payload = [ 6 { 7 "type": "multiple_choice", 8 "created_by": "Sean", 9 "description": "Choose the LLM response which is more accurate.", 10 "options": [ 11 { 12 "label": "Response 1", 13 "value": "response1" 14 }, 15 { 16 "label": "Response 2", 17 "value": "response2" 18 } 19 ] 20 }, 21 { 22 "type": "free_text", 23 "created_by": "Sean", 24 "description": "Please share the reasons for your choice." 25 }, 26 { 27 "type": "multiple_choice", 28 "created_by": "Sean", 29 "description": "Choose the LLM response which is more accurate and explain why.", 30 "options": [ 31 { 32 "label": "string", 33 "value": "string", 34 "type": "array", 35 "description": "Required for multiple_choice_with_free_text type. The options for the instruction.", 36 "items": { 37 "type": "object", 38 "required": ["label", "value", "heading"], 39 "properties": { 40 "label": { 41 "type": "string", 42 "description": "The display text for the option." 43 }, 44 "value": { 45 "type": "string", 46 "description": "The value associated with the option." 47 }, 48 "heading": { 49 "type": "string", 50 "description": "The heading or context for the option." 51 } 52 } 53 } 54 } 55 ], 56 "answer_limit": { 57 "type": "integer", 58 "description": "The maximum number of options a participant can select." 59 } 60 } 61 ] 62 headers = { 63 "Authorization": "<apiKey>", 64 "Content-Type": "application/json" 65 } 66 67 response = requests.put(url, json=payload, headers=headers) 68 69 print(response.json())

1 [ 2 { 3 "id": "0192041c-470f-7336-8e3d-e03fc086a4e1", 4 "created_at": "2024-09-18T07:50:15.055Z", 5 "type": "multiple_choice", 6 "batch_id": "01974850-9e29-744a-811c-b26612812345", 7 "created_by": "Sean", 8 "description": "Choose the LLM response which is more accurate.", 9 "options": [ 10 { 11 "label": "Response 1", 12 "value": "response1" 13 }, 14 { 15 "label": "Response 2", 16 "value": "response2" 17 } 18 ] 19 }, 20 { 21 "id": "0192041c-4710-7336-8e3d-e9b6149c0797", 22 "created_at": "2024-09-18T07:50:15.056Z", 23 "type": "free_text", 24 "batch_id": "01974850-9e29-744a-811c-b26612812345", 25 "created_by": "Sean", 26 "description": "Please share the reasons for your choice." 27 } 28 ]

Updates the 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

Batch ID

Request

This endpoint expects a list of objects.

typeenumRequired

The type of instruction.

Allowed values:

created_bystringRequired

The user who created the instruction.

descriptionstringRequired

The instruction text.

optionslist of objectsOptional

Required for multiple_choice type. The options for the instruction.

Response

Updated

multiple_choiceobject

free_textobject

Authentication

Path Parameters

Request

Response

Errors