Templates

Validate Markdown/Liquid and preview a PDF without saving or sending

post/api/v1/templates/markdown/preview

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/templates/markdown/preview
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Request body

sourcestring required

Markdown with the supported Liquid variable, if/unless and for syntax.

sampleDataobject

Example JSON for previews. Never implicitly fills a generated agreement.

pageSize'A4' | 'Letter'

Response

pdfBase64string required

Base64 encoded PDF. Preview does not save a template or send a document.

pageCountnumber required

Example response

{
  "mergeFields": [
    {
      "name": "client_name",
      "occurrences": 3
    }
  ]
}

Changes

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