Skip to navigation
Benchling APIDocument Export

Get document export task status

Beta

Get the current status of a single-item document export task. When the export completes successfully, the response populates a downloadUrl where the result can be downloaded. The download URL is usable for a limited time after completion. Returns 404 if the task is not found, including when its result has expired.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Response

Export task status
messagestring
statusenum
  • NOT_STARTED: Task has been created but not yet started.
  • IN_PROGRESS: Task is currently running.
  • COMPLETED: Export finished successfully; downloadUrl is populated.
  • FAILED: Export encountered an error.
Allowed values:
downloadUrlstring or nullOptional

Link to download the exported file. Populated only when status is COMPLETED; null otherwise.

Errors

400
Document Export Get Request Bad Request Error
403
Document Export Get Request Forbidden Error
404
Document Export Get Request Not Found Error
429
Document Export Get Request Too Many Requests Error
500
Document Export Get Request Internal Server Error