Get Batch Instructions

GET

https://api.prolific.com/api/v1/data-collection/batches/:batch_id/instructions

GET

/api/v1/data-collection/batches/:batch_id/instructions

1 curl https://api.prolific.com/api/v1/data-collection/batches/batch_id/instructions \
2      -H "Authorization: Token <token>"

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

Get the instructions for an AI Task Builder batch

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

batch_idstringRequired

Batch ID

Response

resultslist of objects or null

metaobject or null

Authentication

Path parameters

Response

Errors