PRprolific
aiTaskBuilder

Get Batch Status

Changed on

Get the current status of an AI Task Builder batch.

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

Request

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

Path parameters

batch_idstring required

The unique identifier of the AI Task Builder batch

Response

OK

status'UNINITIALISED' | 'PROCESSING' | 'READY' | 'ERROR'

The status of the Batch - one of 'UNINITIALISED', 'PROCESSING', 'READY', 'ERROR'

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id get-task-builder-batch-status removed and replaced with aiTaskBuilder_GetTaskBuilderBatchStatus