Update an AI Task Builder batch

1 import requests 2 3 url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id" 4 5 payload = {} 6 headers = { 7 "Authorization": "<apiKey>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.patch(url, json=payload, headers=headers) 12 13 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 "filename": "string" 10 } 11 ], 12 "name": "Data Collection Batch", 13 "status": "UNINITIALISED", 14 "total_task_count": 1, 15 "total_instruction_count": 1, 16 "workspace_id": "6278acb09062db3b35bcbeb0", 17 "schema_version": 1, 18 "total_task_groups": 1, 19 "task_details": { 20 "task_name": "string", 21 "task_introduction": "string", 22 "task_steps": "string" 23 } 24 }

Update an existing AI Task Builder batch. You can update the name, task details, and/or associated dataset. The dataset does not need to be in READY status for updates.

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 batch

Request

This endpoint expects an object.

namestringOptional

task_detailsobjectOptional

dataset_idstringOptionalformat: "uuid"

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

total_task_groupsinteger>=0

task_detailsobject or null

Authentication

Path Parameters

Request

Response

Errors