PRprolific
aiTaskBuilder

Get a Batch

Changed on

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

get/api/v1/data-collection/batches/{batch_id}

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/batches/{batch_id}
  • Auth
    API key in header Authorization

Path parameters

batch_idstring required

The unique identifier of the AI Task Builder batch

Response

Ok

idstring uuid required
created_atstring date-time required

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

created_bystring required

User ID of the Prolific user that created the resource.

namestring required
status'UNINITIALISED' | 'PROCESSING' | 'READY' | 'ERROR' required
total_task_countinteger required
total_instruction_countinteger required
workspace_idstring required
schema_versioninteger required
total_task_groupsinteger required
auto_sync_enabledboolean

When true, datapoints appended to the batch's attached dataset automatically trigger a sync that materialises tasks for them. Optional — absent on batches that have never enabled auto-sync. Absent or false mean auto-sync is off.

Changes

  • 9449de4ad274Revision changes
    • breaking

      added subschema #9 to the /////// response property oneOf list for the response status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API