Prolific aiTaskBuilder API
The aiTaskBuilder API from Prolific — 24 operation(s) for aitaskbuilder.
Prolific aiTaskBuilder API is one of 28 APIs that Prolific publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include aiTaskBuilder. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 31 operations across 24 paths, and defines 179 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.prolific.com.
31 operations
24 paths
179 schemas
17 GET2 PATCH10 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Prolific aiTaskBuilder API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (token).
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…
Paths & Operations 31
Across 24 paths, the API surfaces 31 operations — 17 GET, 2 PATCH, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
aiTaskBuilder 31
GET
/api/v1/data-collection/batches
List Batches
POST
/api/v1/data-collection/batches
Create a Batch
GET
/api/v1/data-collection/batches/{batch_id}
Get a Batch
PATCH
/api/v1/data-collection/batches/{batch_id}
Update a Batch
POST
/api/v1/data-collection/batches/{batch_id}/sync
Sync a Batch
GET
/api/v1/data-collection/batches/{batch_id}/syncs/{sync_id}
Get Batch Sync Status
GET
/api/v1/data-collection/batches/{batch_id}/status
Get Batch Status
POST
/api/v1/data-collection/batches/{batch_id}/setup
Setup a Batch
GET
/api/v1/data-collection/batches/{batch_id}/responses
Get Batch Responses
GET
/api/v1/data-collection/batches/{batch_id}/report/
Get Batch Report
POST
/api/v1/data-collection/batches/{batch_id}/duplicate
Duplicate a Batch
POST
/api/v1/data-collection/batches/{batch_id}/export
Request a Batch Export
GET
/api/v1/data-collection/batches/{batch_id}/export/{export_id}
Get Batch Export Status
POST
/api/v1/data-collection/datasets
Create a Dataset
GET
/api/v1/data-collection/datasets/{dataset_id}
Get a Dataset
PATCH
/api/v1/data-collection/datasets/{dataset_id}
Update a Dataset Schema
GET
/api/v1/data-collection/datasets/{dataset_id}/upload-url/{filename}
Get Dataset Upload URL
GET
/api/v1/data-collection/datasets/{dataset_id}/imports/{import_id}
Get Dataset Import Status
POST
/api/v1/data-collection/datasets/{dataset_id}/datapoints
Append Datapoints to a Dataset
GET
/api/v1/data-collection/datasets/{dataset_id}/schema-migrations/{job_id}
Get Schema Migration Status
GET
/api/v1/data-collection/datasets/{dataset_id}/status
Get Dataset Status
GET
/api/v1/data-collection/batches/{batch_id}/instructions
Get Batch Instructions
POST
/api/v1/data-collection/batches/{batch_id}/instructions
Create Batch Instructions
PUT
/api/v1/data-collection/batches/{batch_id}/instructions
Update Batch Instructions
GET
/api/v1/data-collection/collections
List Collections
POST
/api/v1/data-collection/collections
Create a Collection
GET
/api/v1/data-collection/collections/{collection_id}
Get a Collection
PUT
/api/v1/data-collection/collections/{collection_id}
Update a Collection
GET
/api/v1/data-collection/collections/{collection_id}/responses
Get Collection Responses
POST
/api/v1/data-collection/collections/{collection_id}/export
Request a Collection Export
GET
/api/v1/data-collection/collections/{collection_id}/export/{export_id}
Get Collection Export Status
Schemas 179
The contract defines 179 schemas that model the data the API accepts and returns. The most detailed are AITaskBuilderBatch (14 properties), CollectionInstructionInput (13 properties), AI_Task_Builder_UpdateTaskBuilderDataset_Response_200 (13 properties), ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItems (12 properties). Each schema is shown below with its type and property counts.
AiTaskBuilderBatchCreateTaskDetails
object
3 properties
3 required
AiTaskBuilderFileUploadInstructionType
string
ApiV1DataCollectionBatchesBatchIdPatchRequestBodyContentApplicationJsonSchemaTaskDetails
object
3 properties
3 required
ApiV1DataCollectionBatchesBatchIdInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionsItemsType
string
The type of instruction.
CollectionExportStatusOneOf2Status
string
DatasetImportJob
object
Tracks the lifecycle of a single file upload to a V4 dataset. An import job is created when GET /datasets/{datasetid}/upload-url/{filename} is called. It trans…
11 properties
6 required
ErrorDetail
object
7 properties
4 required
ApiV1DataCollectionBatchesBatchIdInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionsItemsUnitOptionsItemsValue
The value associated with the unit.
CollectionMultipleChoiceWithFreeTextInstructionType
string
CollectionUpdateRequest
object
3 properties
3 required
CollectionCreateRequest
object
4 properties
4 required
CollectionInstructionInputOptionsItems
object
4 properties
2 required
RichTextContentBlockParentType
string
AI_Task_Builder_ListCollections_Response_200
object
2 properties
CollectionFileUploadInstructionType
string
BatchItemsFreeTextWithUnitInstructionType
string
AI_Task_Builder_GetTaskBuilderInstructions_Response_200
object
2 properties
SchemaMigrationJob
object
Tracks the asynchronous re-normalisation of a V4 dataset's datapoints against a newer schema version. Poll GET /datasets/{datasetid}/schema-migrations/{jobid}…
10 properties
6 required
BatchItemsFreeTextInstructionType
string
AITaskBuilderDataset
object
An AI Task Builder dataset. The shape of the response varies by schemaversion: - V3 datasets include status, filename, and haspredeterminedgroupingid. - V4 dat…
12 properties
7 required
CollectionInstructionInput
object
Instruction input for a collection page
13 properties
3 required
AiTaskBuilderMultipleChoiceInstructionOptionsItemsValue
Value returned in responses
ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItemsUnitOptionsItems
object
3 properties
2 required
CollectionItem
object
A page within a collection containing instructions and content blocks
5 properties
5 required
BatchItemsValidationErrorType
string
AITaskBuilderBatch
object
14 properties
12 required
CollectionMultipleChoiceInstructionOptionsItemsValue
BatchItemsMultipleChoiceInstructionType
string
DatasetAppendError
object
A record-level validation error from a synchronous JSONL append request.
3 properties
3 required
CollectionMultipleChoiceWithFreeTextInstructionOptionsItems
object
4 properties
3 required
DatasetAppendResult
object
Result of a synchronous append to a V4 dataset (POST /datasets/{datasetid}/datapoints). accepted counts records that passed validation (newly written plus idem…
3 properties
3 required
ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItems
object
12 properties
2 required
CollectionInstructionInputUnitOptionsItems
object
3 properties
2 required
SchemaMigrationError
object
A single record-level failure — a field that was invalid under the new schema and so was nulled.
3 properties
3 required
ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItemsOptionsItems
object
3 properties
2 required
ApiV1DataCollectionBatchesBatchIdReportGetResponsesContentApplicationJsonSchemaHttpMethod
string
HTTP method to use with the presigned URL
CollectionResponseResponseAnswerItems
object
1 property
ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItemsUnitOptionsItemsValue
The value associated with the unit.
ApiV1DataCollectionBatchesBatchIdResponsesGetResponsesContentApplicationJsonSchemaMeta
object
1 property
AI_Task_Builder_GetTaskBuilderDatasetStatus_Response_200
object
1 property
CollectionSchemaVersion
string
CollectionInstructionInputUnitPosition
string
Required for freetextwithunit. Position of the unit selector relative to the text input.
ApiV1DataCollectionBatchesPostRequestBodyContentApplicationJsonSchemaTaskDetails
object
Task metadata displayed to participants
3 properties
3 required
ApiV1DataCollectionBatchesBatchIdStatusGetResponsesContentApplicationJsonSchemaStatus
string
The status of the Batch - one of 'UNINITIALISED', 'PROCESSING', 'READY', 'ERROR'
ApiV1DataCollectionBatchesGetResponsesContentApplicationJsonSchemaMeta
object
1 property
CollectionExportStatus2
object
An export job that failed to generate, or whose archive has since been deleted. Re-send POST /collections/{collectionid}/export to retry.
1 property
1 required
RichTextContentBlockSchemaVersion
string
BatchItemsRichTextBlockType
string
AI_Task_Builder_GetTaskBuilderBatches_Response_200
object
2 properties
ApiV1DataCollectionDatasetsDatasetIdPatchResponsesContentApplicationJsonSchemaStatus
string
Processing status. V3 datasets only. V4 datasets track status per import job via imports.
DatasetImportJobType
string
The type of import. Currently always fileupload.
ApiV1DataCollectionDatasetsDatasetIdUploadUrlFilenameGetResponsesContentApplicationJsonSchemaHttpMethod
string
HTTP method to use with the presigned URL.
Collection
object
10 properties
8 required
ApiV1DataCollectionBatchesBatchIdInstructionsGetResponsesContentApplicationJsonSchemaMeta
object
1 property
BatchExportStatusOneOf2Status
string
DatasetSchema
object
A researcher-defined schema that specifies the fields in a V4 dataset. Each field has a type that determines how it is rendered to participants and how it can…
2 properties
2 required
PageItem
An instruction or content block within a page
CollectionFreeTextWithUnitInstructionUnitOptionsItemsValue
Value returned in responses
CollectionMultipleChoiceInstructionOptionsItems
object
3 properties
2 required
AITaskBuilderInstruction
AI_Task_Builder_GetTaskBuilderBatchStatus_Response_200
object
1 property
AITaskBuilderTaskResponse
object
11 properties
6 required
CollectionExportCompleteStatus
string
AI_Task_Builder_UpdateTaskBuilderDataset_Response_200
object
An AI Task Builder dataset. The shape of the response varies by schemaversion: - V3 datasets include status, filename, and haspredeterminedgroupingid. - V4 dat…
13 properties
7 required
BatchItemsMultipleChoiceInstructionOptionsItemsValue
BatchExportStatus
The current status of a batch export job.
BatchExportStatus0
object
An export job that has been enqueued and is currently being generated.
2 properties
2 required
ContentBlockInputContentFormat
string
Format of the content field. When set to "markdown", content is converted to HTML server-side before storage. Defaults to "html".
AiTaskBuilderMultipleChoiceWithFreeTextInstructionOptionsItems
object
4 properties
3 required
ErrorDetailDetail2
object
All fields with validation errors
1 property
AITaskBuilderBatchCreate
object
11 properties
10 required
CollectionResponseResponseAnswerItemsValue
BatchItemsMultipleChoiceWithFreeTextInstructionOptionsItemsValue
RichTextContentBlockType
string
BatchExportCompleteStatus
string
CollectionFreeTextWithUnitInstructionUnitOptionsItems
object
3 properties
2 required
AI_Task_Builder_getDatasetUploadUrl_Response_201
object
7 properties
5 required
BatchItemsFreeTextWithUnitInstructionUnitOptionsItemsValue
ValidationRuleType
string
The expected input type. When "number", the input must be numeric and min/max constrain the numeric value. When "string", the input is treated as text and min/…
BatchItemsFreeTextWithUnitInstructionUnitPosition
string
Position of the unit selector relative to the text input.
BatchItemsPage
object
A single page of a batch's inline layout. Each page is rendered as one screen to participants and contains an ordered list of rows. On responses, includes a se…
2 properties
1 required
Error
object
1 property
1 required
AiTaskBuilderFreeTextWithUnitInstructionUnitPosition
string
Position of the unit selector relative to the text input. Use 'prefix' for units before the input (e.g., currency symbols) or 'suffix' for units after the inpu…
CollectionItemSchemaVersion
string
SyncJobStatus
string
Current status of the sync job.
AiTaskBuilderMultipleChoiceInstructionType
string
AiTaskBuilderFreeTextWithUnitInstructionType
string
CollectionInstructionInputUnitOptionsItemsValue
DatasetSchemaFieldType
string
Field type: - text — a text value shown to participants. Can be referenced by datasetfield items in batchitems. - imageurl — a URL pointing to an image shown t…
BatchItemsImageBlockType
string
CollectionExportStatus0
object
An export job that has been enqueued and is currently being generated.
2 properties
2 required
AiTaskBuilderMultipleChoiceInstructionOptionsItems
object
3 properties
2 required
AiTaskBuilderBatchDatasetsItems
object
3 properties
3 required
BatchExportStatusOneOf1Status
string
AiTaskBuilderBatchTaskDetails
object
3 properties
3 required
AiTaskBuilderMultipleChoiceWithFreeTextInstructionType
string
AiTaskBuilderFreeTextWithUnitInstructionUnitOptionsItemsValue
Value returned in responses
CollectionMultipleChoiceWithFreeTextInstructionParentType
string
CollectionFreeTextInstructionType
string
BatchItemsRow
object
A row within a page. Renders 1 or 2 columns side-by-side.
2 properties
1 required
ApiV1DataCollectionDatasetsDatasetIdPatchResponsesContentApplicationJsonSchemaSchemaVersion
string
Internal dataset version. 3 = legacy CSV/ZIP; 4 = structured schema with JSONL/CSV import tracking.
BatchItemsMultipleChoiceWithFreeTextInstructionType
string
ApiV1DataCollectionDatasetsDatasetIdStatusGetResponsesContentApplicationJsonSchemaStatus
string
The status of the Dataset - one of 'UNINITIALISED', 'PROCESSING', 'READY', 'ERROR'
AI_Task_Builder_SetupTaskBuilderBatch_Response_202
object
Empty response body
AiTaskBuilderMultipleChoiceWithFreeTextInstructionParentType
string
ErrorDetailDetail
Error detail
AiTaskBuilderTaskResponseResponseType
string
ApiV1DataCollectionCollectionsGetResponsesContentApplicationJsonSchemaMeta
object
1 property
ImageContentBlockParentType
string
BatchItemsColumn
object
A column within a row. Contains one or more items rendered top-to-bottom.
2 properties
1 required
AiTaskBuilderDatasetStatus
string
Processing status. V3 datasets only. V4 datasets track status per import job via imports.
AiTaskBuilderFreeTextWithUnitInstructionUnitOptionsItems
object
3 properties
2 required
ApiV1DataCollectionBatchesBatchIdInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionsItemsOptionsItems
object
3 properties
2 required
TaskDetails
object
Task metadata displayed to participants
3 properties
3 required
AiTaskBuilderFreeTextWithUnitInstructionParentType
string
CollectionResponse
object
A participant's response to a collection
6 properties
5 required
CollectionInstructionInputOptionsItemsValue
CollectionFreeTextWithUnitInstructionParentType
string
BatchExportStatus2
object
An export job that failed to generate, or whose archive has since been deleted. Re-send POST /batches/{batchid}/export to retry.
1 property
1 required
ContentBlockInputType
string
AiTaskBuilderFreeTextInputInstructionParentType
string
DatasetSchemaField
object
Descriptor for a single field in a dataset schema.
2 properties
1 required
CollectionFreeTextWithUnitInstructionUnitPosition
string
Position of the unit selector relative to the text input. Use 'prefix' for units before the input (e.g., currency symbols) or 'suffix' for units after the inpu…
SchemaMigrationJobStatus
string
Current status of the migration job.
AiTaskBuilderBatchCreateStatus
string
BatchExportStatus1
object
An export job that has completed successfully. The ZIP archive is ready to download.
3 properties
3 required
ApiV1DataCollectionCollectionsCollectionIdResponsesGetResponsesContentApplicationJsonSchemaMeta
object
1 property
BatchItemsFreeTextWithUnitInstructionUnitOptionsItems
object
3 properties
2 required
AI_Task_Builder_GetTaskBuilderBatchReport_Response_200
object
3 properties
ImageContentBlockSchemaVersion
string
BatchItemsValidationError
object
422 Unprocessable Entity payload returned when batchitems fails server-side validation on create or update. Each entry in issues pinpoints the offending item u…
3 properties
3 required
CollectionFreeTextWithUnitInstructionType
string
ApiV1DataCollectionBatchesBatchIdInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionsItemsUnitOptionsItems
object
3 properties
2 required
ContentBlockInput
object
Content block input for a collection page
7 properties
1 required
CollectionExportStatusOneOf1Status
string
BatchItemsMultipleChoiceWithFreeTextInstructionOptionsItems
object
4 properties
3 required
CollectionMultipleChoiceInstructionType
string
BatchItemsItem
A single item within a column. One of: a dataset field reference (datasetfield), a content block (image, richtext), or an instruction (freetext, freetextwithun…
AiTaskBuilderBatchStatus
string
AiTaskBuilderTaskResponseResponseAnswerItems
object
The participant's answer value
1 property
AiTaskBuilderMultipleChoiceWithFreeTextInstructionOptionsItemsValue
Value returned in responses
AiTaskBuilderMultipleChoiceInstructionParentType
string
ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItemsUnitPosition
string
Required for freetextwithunit. Position of the unit selector relative to the text input. Use 'prefix' for units before the input (e.g., currency symbols) or 's…
CollectionMultipleChoiceWithFreeTextInstructionOptionsItemsValue
BatchExportComplete
object
An export job that has completed successfully. The ZIP archive is ready to download.
3 properties
3 required
ApiV1DataCollectionBatchesBatchIdInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionsItemsUnitPosition
string
Required for freetextwithunit. Position of the unit selector relative to the text input. Use 'prefix' for units before the input (e.g., currency symbols) or 's…
BatchItemsFileUploadInstructionType
string
PageItemInput
An instruction or content block input. Include id to preserve an existing item when updating.
ImageContentBlockType
string
BatchItemsDatasetFieldRefType
string
CollectionFreeTextInstructionParentType
string
AI_Task_Builder_GetTaskBuilderBatchTaskResponses_Response_200
object
2 properties
CollectionResponseResponse
object
3 properties
3 required
AiTaskBuilderFreeTextInputInstructionType
string
SyncJob
object
Tracks the asynchronous materialisation of tasks for datapoints appended to a batch's dataset since setup or the last sync. Created by POST /batches/{batchid}/…
11 properties
6 required
ValidationRule
object
Optional validation constraints for input values
3 properties
1 required
AiTaskBuilderFileUploadInstructionParentType
string
CollectionExportStatusOneOf0Status
string
ApiV1DataCollectionBatchesBatchIdInstructionsPutRequestBodyContentApplicationJsonSchemaInstructionsItemsType
string
The type of instruction.
CollectionExportStatus
The current status of a collection export job.
CollectionItemInput
object
A page within a collection. Include id to preserve an existing page when updating.
2 properties
1 required
BatchItemsMultipleChoiceInstructionOptionsItems
object
3 properties
2 required
BatchItemsValidationErrorIssuesItems
object
7 properties
6 required
AI_Task_Builder_GetCollectionResponses_Response_200
object
2 properties
BatchExportStatusOneOf0Status
string
CollectionResponseResponseType
string
AiTaskBuilderDatasetSchemaVersion
string
Internal dataset version. 3 = legacy CSV/ZIP; 4 = structured schema with JSONL/CSV import tracking.
AiTaskBuilderBatchCreateDatasetsItems
object
2 properties
2 required
CollectionMultipleChoiceInstructionParentType
string
CollectionExportComplete
object
An export job that has completed successfully. The ZIP archive is ready to download.
3 properties
3 required
AiTaskBuilderTaskResponseResponse
object
3 properties
3 required
DatasetImportJobStatus
string
Current status of the import job.
AiTaskBuilderTaskResponseResponseAnswerItemsValue
ImportJobError
object
A record-level validation error from a partial import.
3 properties
CollectionExportStatus1
object
An export job that has completed successfully. The ZIP archive is ready to download.
3 properties
3 required
ApiV1DataCollectionBatchesBatchIdInstructionsPostRequestBodyContentApplicationJsonSchemaInstructionsItems
object
11 properties
2 required
CollectionInstructionInputType
string
BatchItemsRichTextBlockContentFormat
string
Format of the content field. Defaults to html.
CollectionFileUploadInstructionParentType
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Prolific 12
Other APIs Prolific publishes across the network.
Prolific bonuses API
Prolific credentials API
Prolific filters API
Prolific filterSets API
Prolific invitations API
Prolific messages API
Prolific participantGroups API
Prolific projects API
Prolific rewardRecommendations API
Prolific studies API
Prolific submissionFeedbackUpload API
Prolific submissions API
#aiTaskBuilder
Where this information came from
This is an independent, third-party profile of Prolific aiTaskBuilder API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.