Create AI Task Builder Instructions

1 curl -X POST https://api.prolific.com/api/v1/data-collection/batches/5f7b5e9a-3f3c-4b3e-8f1a-1a2b3c4d5e6f/instructions \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '[ 5 { 6 "type": "multiple_choice", 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 "type": "free_text", 22 "created_by": "Sean", 23 "description": "Please share the reasons for your choice." 24 }, 25 { 26 "type": "multiple_choice_with_free_text", 27 "created_by": "Sean", 28 "description": "Choose the LLM response which is more accurate and explain why.", 29 "answer_limit": { 30 "type": "integer", 31 "description": "The maximum number of options a participant can select." 32 }, 33 "options": { 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": [ 39 "label", 40 "value", 41 "heading" 42 ], 43 "properties": { 44 "label": { 45 "type": "string", 46 "description": "The display text for the option." 47 }, 48 "value": { 49 "type": "string", 50 "description": "The value associated with the option." 51 }, 52 "heading": { 53 "type": "string", 54 "description": "The heading or context for the option." 55 } 56 } 57 } 58 } 59 } 60 ]'

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 ]

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 a list of objects.

instructionslist of objectsOptional

The instructions to create for the AI Task Builder batch.

Response

Created

multiple_choiceobject

free_textobject

Authentication

Path Parameters

Request

Response

Errors