Template Preparation

Create a one-hour, single-template preparation session

Call from your server. Without templateId, creates an inactive PDF template with configured signer roles. With templateId, opens a scoped editing draft of an existing PDF in the key mode and publishes to the original ID on save. Browser access can only prepare that template. In review mode your backend supplies the locked field definitions. API credentials must never reach the browser.

post/api/v1/template-preparation-sessions

Request

Base URL: https://api.korala.ai
URL: https://api.korala.ai/api/v1/template-preparation-sessions
Auth: API key in header X-API-Key

Request body

mode'full' | 'review'

templateIdstring

Existing uploaded PDF template to edit. Must have signer roles and match the API key mode.

namestring

Required for a new template; optional when editing templateId.

roleNamestring

parentOriginstring required

Exact origin of the embedding application.

Example request

{
  "signerRoles": [
    {
      "name": "Client",
      "signingOrder": 1
    }
  ],
  "fields": [
    {
      "options": [
        "CA",
        "NY"
      ],
      "groupKey": "fed_tax_class",
      "groupRequired": true
    }
  ],
  "name": "Agreement",
  "parentOrigin": "https://app.example.com"
}

Response

tokenstring required

templateIdstring required

embedUrlstring required

expiresAtstring required

Changes

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