Get an AI Task Builder instructions

1 import requests 2 3 url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/instructions" 4 5 headers = {"Authorization": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 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 ]

Get the instructions for an AI 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

Response

Updated

multiple_choiceobject

free_textobject

Authentication

Path Parameters

Response

Errors