Synchronous document generation

post

Authorizations

X-Api-KeystringRequired

Body

formatstringOptional

Output format (currently only 'docx' supported)

Default: docx

webhookUrlstring · uri · min: 1 · max: 2083 · nullableOptional

Completion webhook URL (must be HTTPS)

Default: null

Responses

200

The generated document itself, returned as application/vnd.openxmlformats-officedocument.wordprocessingml.document with Content-Disposition: attachment; filename="document.docx". This response is a binary file, not JSON — write the body to disk rather than parsing it.

No content

400

The request body is missing or invalid.

401

Authentication required — the X-Api-Key header is missing or invalid.

post/generate/sync

POST /generate/sync HTTP/1.1
Host: api-docai-uat.uptiq.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 364

{
  "data": [
    {
      "sectionData": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "sectionKey": "text"
    }
  ],
  "format": "docx",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "style": {
    "fontFamily": "Calibri",
    "fontSize": 11,
    "headerFooter": true,
    "lenderName": "text",
    "pageNumbers": true,
    "primaryColor": "1F4E79",
    "secondaryColor": "text",
    "tableOfContents": false
  },
  "webhookUrl": "https://example.com"
}

No content