PRprolific
aiTaskBuilder

Get Dataset Upload URL

Changed on

Generates a presigned S3 URL for uploading a file to the dataset. Use the returned URL to PUT the file directly to S3.

V3 datasets (CSV/ZIP): returns upload_url and http_method. After the upload completes, poll GET /datasets/{dataset_id}/status for processing status.

V4 datasets (JSONL/CSV): additionally returns import_id. After the upload completes, poll GET /datasets/{dataset_id}/imports/{import_id} for per-upload status. Multiple upload URLs can be requested before any upload completes — each creates a distinct import job and S3 key.

Supported file types:

  • V3: .csv, .zip
  • V4: .csv, .jsonl
get/api/v1/data-collection/datasets/{dataset_id}/upload-url/{filename}

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/datasets/{dataset_id}/upload-url/{filename}
  • Auth
    API key in header Authorization

Path parameters

dataset_idstring required

The ID of the dataset to upload files to

filenamestring required

The name of the file to upload (e.g. data.jsonl)

Response

Presigned URL generated successfully

dataset_idstring uuid required

The ID of the dataset the upload URL was requested for.

upload_urlstring required

Presigned S3 URL. Make a PUT request to this URL with your file as the body.

http_method'PUT' required

HTTP method to use with the presigned URL.

content_typestring required

The Content-Type header value to use when making the S3 PUT request. Use this value exactly — e.g. application/x-ndjson for JSONL files.

expires_atstring date-time required

When the presigned URL expires (ISO 8601, UTC). The URL cannot be used after this time.

file_keystring

The S3 object key for the uploaded file. Provided for reference only.

import_idstring uuid

Import job ID. V4 datasets only. Use with GET /datasets/{dataset_id}/imports/{import_id} to poll for upload and processing status.

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-dataset-upload-url removed and replaced with aiTaskBuilder_getDatasetUploadUrl