Create an AI Task Builder batch

1 import requests 2 3 url = "https://api.prolific.com/api/v1/data-collection/batches" 4 5 payload = { 6 "name": "Data Collection Batch", 7 "workspace_id": "6278acb09062db3b35bcbeb0" 8 } 9 headers = { 10 "Authorization": "<apiKey>", 11 "Content-Type": "application/json" 12 } 13 14 response = requests.post(url, json=payload, headers=headers) 15 16 print(response.json())

1 { 2 "id": "string", 3 "created_at": "2024-01-15T09:30:00Z", 4 "created_by": "6278cb09062dbb35bc4abebc", 5 "datasets": [ 6 { 7 "id": "string", 8 "total_datapoint_count": 1 9 } 10 ], 11 "name": "Data Collection Batch", 12 "status": "UNINITIALISED", 13 "total_task_count": 1, 14 "total_instruction_count": 1, 15 "workspace_id": "6278acb09062db3b35bcbeb0", 16 "task_details": { 17 "task_name": "string", 18 "task_introduction": "string", 19 "task_steps": "string" 20 } 21 }

Create a new AI Task Builder batch. The dataset does not need to be in READY status at creation time.

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>`.

Request

This endpoint expects an object.

namestringRequired

workspace_idstringRequired

dataset_idstringOptional

Response

Created

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

task_detailsobject

Authentication

Request

Response

Errors