Generate document (Async)

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

201

Created

application/json

generationIdstringRequired

Generation ID

messagestringRequired

Status message

requestIdstringRequired

Request ID

statusstringRequired

Status

successbooleanRequired

Success flag

400

Bad Request

application/json

401

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

post/generate

POST /generate 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"
}

{
  "generationId": "text",
  "message": "text",
  "requestId": "text",
  "status": "text",
  "success": true
}