Sign in
File Upload Helpers

Create document file storage upload URL

<small>Requires an API token with the Document Manager role.</small>

Generates a presigned URL for securely uploading a file to cloud storage. The uploaded file can then be associated with a document via the Store a PDF file in a document's file storage endpoint.

The returned URL expires after a limited time and should be used immediately for upload. Upload the file with a POST request to the returned URL, sending the provided fields as form fields in the request body, followed by the file contents in a file field.

The request accepts a content_type string matching one of the rows below, or any image/* MIME type.

File typecontent_type
CSVapplication/csv, text/csv
MS Word (.doc)application/msword
MS Word (.docx)application/vnd.openxmlformats-officedocument.wordprocessingml.document
PDFapplication/pdf
RTFapplication/rtf
Excel (.xls)application/vnd.ms-excel
Excel (.xlsx)application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Outlook message (.msg)application/vnd.ms-outlook
EMLmessage/rfc822
PowerPoint (.ppt)application/vnd.ms-powerpoint
PowerPoint (.pptx)application/vnd.openxmlformats-officedocument.presentationml.presentation
XMLapplication/xml, text/xml
Plain text (.txt)text/plain
ZIPapplication/zip, application/x-zip, application/x-zip-compressed
Imagesimage/* (e.g. image/png, image/jpeg, image/gif)

For a complete guide with examples, see How to store a file in a document's file storage.

post/file-uploads/document-file-storage

Request body

content_typestring required

The MIME type string of the file being uploaded.

Example request

{
  "content_type": "application/pdf"
}

Response

SignedUploadUrlResource

Example response

{
  "data": {
    "uuid": "ab2665c1-9a7c-4230-a431-21682eb302aa",
    "url": "https://s3.eu-central-1.amazonaws.com/...",
    "method": "POST",
    "expires_at": "2019-08-24T14:15:22Z"
  }
}

Changes