Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
File Upload Helpers

Create document PDF upload URL

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

Generates a presigned URL for securely uploading a PDF file to cloud storage. The uploaded PDF can then be used to create a document via the Create document from PDF endpoint.

The returned URL expires after a limited time and should be used immediately for upload. The method field of the response tells you which kind of HTTP request to make to perform the upload. If it is POST, make a POST request, including the provided fields from the response as fields in the request body. If it is PUT, make a PUT request, including the provided headers from the response in the HTTP headers. Your API client should support both upload methods, as PUT uploads are deprecated and will be removed.

For a complete guide with examples, see How to create a document from a PDF file.

post/file-uploads/document-pdf

Request body

method'PUT' | 'POST'

Response

SignedUploadUrlResource

Example response

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