Get Batch Instructions | Prolific API

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

{
  "results": [
    {
      "id": "0192041c-470f-7336-8e3d-e03fc086a4e1",
      "created_at": "2024-09-18T07:50:15.055Z",
      "type": "multiple_choice",
      "parent_id": "01974850-9e29-744a-811c-b26612812345",
      "parent_type": "batch",
      "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",
      "parent_id": "01974850-9e29-744a-811c-b26612812345",
      "parent_type": "batch",
      "created_by": "Sean",
      "description": "Please share the reasons for your choice."
    },
    {
      "id": "0192041c-4712-7336-8e3d-a2b3c4d5e6f7",
      "created_at": "2024-09-18T07:50:15.057Z",
      "type": "multiple_choice_with_free_text",
      "parent_id": "01974850-9e29-744a-811c-b26612812345",
      "parent_type": "batch",
      "created_by": "Sean",
      "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"
        }
      ]
    },
    {
      "id": "0192041c-4713-7336-8e3d-b3c4d5e6f7a8",
      "created_at": "2024-09-18T07:50:15.058Z",
      "type": "free_text_with_unit",
      "parent_id": "01974850-9e29-744a-811c-b26612812345",
      "parent_type": "batch",
      "created_by": "Sean",
      "description": "What is your height?",
      "unit_options": [
        {
          "label": "Centimeters",
          "value": "cm",
          "validation": {
            "type": "number",
            "min": 50,
            "max": 300
          }
        },
        {
          "label": "Feet",
          "value": "ft",
          "validation": {
            "type": "number",
            "min": 1,
            "max": 9
          }
        }
      ],
      "unit_position": "suffix"
    },
    {
      "id": "0192041c-4711-7336-8e3d-f1c7260d1898",
      "created_at": "2024-09-18T07:50:15.059Z",
      "type": "file_upload",
      "parent_id": "01974850-9e29-744a-811c-b26612812345",
      "parent_type": "batch",
      "created_by": "Sean",
      "description": "Upload a photo of the item",
      "accepted_file_types": [
        ".jpg",
        ".jpeg",
        ".png"
      ],
      "max_file_size_mb": 10,
      "min_file_count": 1,
      "max_file_count": 3
    }
  ],
  "meta": {
    "count": 5
  }
}

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

metaobject

Errors

4XX

Client Request Error