Sign in

v4

OpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Get Batch Export Status

Polls the status of an asynchronous batch export job initiated by POST /batches/{batch_id}/export.

Returns the current status of the export:

  • generating — the export is still being built; continue polling.
  • complete — the export is ready; a presigned HTTPS download URL is included. URLs are valid for 1 hour and are automatically refreshed if expired.
  • failed — generation failed (e.g. the archive was deleted from storage). Re-send POST /batches/{batch_id}/export to retry.
get/api/v1/data-collection/batches/{batch_id}/export/{export_id}

Path parameters

batch_idstring required
export_idstring required

Headers

Authorizationstring required

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>.

Response

Export status

OR
OR