Get document generation details

get

Authorizations

X-Api-KeystringRequired

Path parameters

_idstringRequired

Responses

200

OK

application/json

dataany · nullableOptionalDefault: null

messagestring · nullableOptionalDefault: null

statusstring · enumOptionalDefault: successPossible values:

400

Bad Request

application/json

401

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

500

Returned for every input, with "Invalid generation ID format" — including the exact generationId returned by POST /generate. Verified against the issued UUID, a hyphen-stripped form, a prefixed form and a nil UUID. This endpoint is currently unusable; collect generated documents via POST /generate/sync or a completion webhook. Known defect — see the API Reference.

get/generate/{_id}

GET /generate/{_id} HTTP/1.1
Host: api-docai-uat.uptiq.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "data": null,
  "generation": {
    "_id": "text",
    "accountId": "text",
    "createdAt": "text",
    "data": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "documentType": "text",
    "error": "text",
    "errorDetails": {
      "message": "text",
      "stack": "text",
      "statusCode": 1,
      "type": "text"
    },
    "failedAt": "text",
    "format": "text",
    "jobEndTime": "text",
    "jobStartTime": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "processedAt": "text",
    "processingAttempts": 0,
    "requestId": "text",
    "status": "text",
    "storageInfo": {
      "container": "text",
      "contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "key": "text",
      "provider": "text",
      "size": 1,
      "uploadedAt": "text"
    },
    "style": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "updatedAt": "text",
    "webhookUrl": "text"
  },
  "message": "text",
  "status": "success"
}