Document AI — DMS

Validate Document Template

Check a stored template (template_id, optional template_version) or an inline html_content: syntax errors with line and column, used variables, lists, conditions and images, unknown helpers, schema cross-check and sample data check...

post/document_generation/template-validate

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/document_generation/template-validate
  • Auth: HTTP bearer

Request body

template_idstring

Stored template to check.

template_versioninteger

Version to check (default: current).

html_contentstring

Inline template to check instead of template_id.

engine'hbs_v2' | 'po_regex_v1'

Engine for inline templates (default hbs_v2).

variables_schemaobject

Inline schema to cross-check.

sample_dataobject

Inline sample data to check against the schema.

Response

Success

status'success' required
_billingobject

Changes

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