Skip to navigation
Benchling APIDocument Export

Export a single item to a downloadable file

Beta

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.

Authentication

AuthorizationBearer

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

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
idstringRequired<=255 characters
API ID of the item to export.
formatenumOptional

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.

Allowed values:

Response

Export task started
pollingUristring
taskIdstring

Errors

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