Template Preparation Browser

get/api/v1/template-preparation

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/template-preparation
  • Auth: HTTP bearer

Headers

authorizationstring required

Response

removableFieldIdsstring[] required

Review fields the browser may remove now. The API protects the last linked placement and any required minimum.

mode'full' | 'review' required
reviewReadyboolean required
parentOriginstring required
uploadedboolean required
completedboolean required

Example response

{
  "template": {
    "formFieldsDetected": 23,
    "detectedMergeFields": [
      {
        "name": "client_name",
        "occurrences": 3
      }
    ],
    "fields": [
      {
        "inputMask": "###-##-####",
        "fontSize": 9,
        "textColor": "#000080",
        "fontFamily": "Helvetica-Bold"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.