Get a Batch | Prolific API

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

{
  "id": "a3f47c2e-9b1d-4f3a-8c2e-7d9f4b6a1e2c",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "d4e5f6a7-b8c9-40d1-9e2f-3a4b5c6d7e8f",
      "total_datapoint_count": 1500,
      "filename": "customer_feedback_2024.csv"
    }
  ],
  "name": "Customer Feedback Data Batch Q1 2024",
  "status": "UNINITIALISED",
  "total_task_count": 25,
  "total_instruction_count": 5,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "schema_version": 1,
  "task_details": {
    "task_name": "Sentiment Analysis Annotation",
    "task_introduction": "Annotate customer feedback entries to identify sentiment polarity.",
    "task_steps": "1. Read each feedback entry. 2. Label sentiment as Positive, Negative, or Neutral. 3. Submit annotations for review."
  },
  "total_task_groups": 3
}

Get a specific AI Task Builder batch by its unique identifier.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

batch_idstringRequired

The unique identifier of the AI Task Builder batch

Response

idstringformat: "uuid"

created_atdatetime

An ISO-8601 formatted string representing the batch creation time, in UTC.

created_bystring

User ID of the Prolific user that created the resource.

datasetslist of objects

namestring

statusenum

Allowed values:

total_task_countinteger>=0

total_instruction_countinteger>=0

workspace_idstring

schema_versioninteger

task_detailsobject

total_task_groupsinteger>=0

Authentication

Path parameters

Response

Errors