BEbenchling
documentExport

Export a single item to a downloadable file

Create an asynchronous task that exports a single item that can be downloaded as a ZIP archive. The task can be polled via the returned pollingUri for status and, on success, a download link.

Supported item types are resolved from the id prefix: notebook entries (etr_), worksheets (wks_), sequences (seq_), proteins (prtn_), and molecules (mol_).

In rare cases, attachments still being scanned for viruses are omitted from the export.

post/api/v3/document-export

Request

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

Headers

EARLY-ACCESSstring

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

Request body

format'pdf' | 'html'

Export format. Only supported for notebook entries (pdf or html, default pdf). All other item types render to their single native output, so providing format for a non-entry item is rejected with a 400.

idstring required

API ID of the item to export.

Response

Export task started

pollingUristring required
taskIdstring required

Changes

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