Skip to main content

Create a document upload handle

POST 
/v1/docgen/uploads

Creates a pre-signed upload URL for staging large documents into storage before referencing them by ID in template creation or import.

Upload flow:

  1. Call POST /v1/docgen/uploads with the document contentType and optional sizeBytes.
  2. Issue an HTTP PUT request directly to the returned uploadUrl with the specified headers and raw binary bytes within 15 minutes.
  3. Supply the returned uploadId as templateContentUploadId when creating a DOCX template via POST /v1/docgen/templates, or as documentUploadId within templateJson.documents[] when importing via POST /v1/docgen/templates/import-from-source within 24 hours.

Request​

Responses​

Document upload handle created

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.

    Cache-Control

    Directs caches not to store responses containing pre-signed URLs.