Attachment

Create Attachment

Create Attachment.

post/api/v3/attachment

Request

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

Request body

generateImagePreviewboolean

Whether to generate an image preview for the attachment. Defaults to false.

generatePdfPreviewboolean

Whether to generate a PDF preview for the attachment. Defaults to false.

scratchFileIdstring required

ID of the ScratchFile to copy into the Attachment.

Response

Created

__typenamestring
createdAtstring datetime
downloadUrlstring nullable

A pre-signed download URL. The URL may be null if the file did not upload successfully.

idstring
mimeTypestring

The MIME type of the file, e.g. 'image/jpeg'

namestring
uploadStatus'SUCCEEDED' | 'FAILED_VALIDATION' | 'IN_PROGRESS' | 'NOT_UPLOADED'

Whether the attachment uploaded successfully, failed to upload or is still uploading.

Changes

No recorded changes to this operation across all 2 revisions of this API.