Document Templates

Preview the template PDF

GET/document-templates/{id}/preview
document-templates:readpreview_document_templateRead-only

Streams the template's PDF inline for preview. Only PDF templates are previewable; a DOCX template returns a not_previewable validation error.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

200

The template PDF.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/document-templates/{id}/preview\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"