BEbenchling
documentExport

Get document export task status

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.

get/api/v3/tasks/document-export/{task_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

task_idstring required

Headers

EARLY-ACCESSstring

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

Response

Export task status

downloadUrlstring nullable

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

messagestring required
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required
  • 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.

Changes

No recorded changes to this operation across all 1 revision of this API.