Get a Batch | Prolific API

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

{
  "id": "a3f47c2e-9d4b-4f1a-8b2e-3c9d7f5a1b2c",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "d9f1e7a4-3c2b-4e5f-9a7d-8b6c4e2f1a0b",
      "total_datapoint_count": 1500,
      "filename": "user_responses_2024-01.csv"
    }
  ],
  "name": "Data Collection Batch",
  "status": "UNINITIALISED",
  "total_task_count": 120,
  "total_instruction_count": 5,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "schema_version": 1,
  "task_details": {
    "task_name": "Sentiment Analysis Task",
    "task_introduction": "<p>Welcome to the sentiment analysis task. Your goal is to classify the sentiment of given text samples.</p>",
    "task_steps": "<ol><li>Read the text carefully.</li><li>Choose the sentiment category that best fits the text.</li><li>Submit your response.</li></ol>"
  },
  "total_task_groups": 3
}

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

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

{
  "id": "a3f47c2e-9d4b-4f1a-8b2e-3c9d7f5a1b2c",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "d9f1e7a4-3c2b-4e5f-9a7d-8b6c4e2f1a0b",
      "total_datapoint_count": 1500,
      "filename": "user_responses_2024-01.csv"
    }
  ],
  "name": "Data Collection Batch",
  "status": "UNINITIALISED",
  "total_task_count": 120,
  "total_instruction_count": 5,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "schema_version": 1,
  "task_details": {
    "task_name": "Sentiment Analysis Task",
    "task_introduction": "<p>Welcome to the sentiment analysis task. Your goal is to classify the sentiment of given text samples.</p>",
    "task_steps": "<ol><li>Read the text carefully.</li><li>Choose the sentiment category that best fits the text.</li><li>Submit your response.</li></ol>"
  },
  "total_task_groups": 3
}

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

Authentication

AuthorizationToken

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

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

Errors

4XX

Client Request Error

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

1	{
2	"id": "a3f47c2e-9d4b-4f1a-8b2e-3c9d7f5a1b2c",
3	"created_at": "2024-01-15T09:30:00Z",
4	"created_by": "6278cb09062dbb35bc4abebc",
5	"datasets": [
6	{
7	"id": "d9f1e7a4-3c2b-4e5f-9a7d-8b6c4e2f1a0b",
8	"total_datapoint_count": 1500,
9	"filename": "user_responses_2024-01.csv"
10	}
11	],
12	"name": "Data Collection Batch",
13	"status": "UNINITIALISED",
14	"total_task_count": 120,
15	"total_instruction_count": 5,
16	"workspace_id": "6278acb09062db3b35bcbeb0",
17	"schema_version": 1,
18	"task_details": {
19	"task_name": "Sentiment Analysis Task",
20	"task_introduction": "<p>Welcome to the sentiment analysis task. Your goal is to classify the sentiment of given text samples.</p>",
21	"task_steps": "<ol><li>Read the text carefully.</li><li>Choose the sentiment category that best fits the text.</li><li>Submit your response.</li></ol>"
22	},
23	"total_task_groups": 3
24	}