Metadata

The metadata object sets PDF document properties that appear in the file's properties panel and are used by search engines, document management systems, and screen readers.

All metadata fields are optional.

Properties

Property	Type	Description
title	string	Document title displayed in the PDF viewer title bar
author	string	Document author name
subject	string	Brief description of the document's subject
keywords	string	Comma-separated keywords for search and classification
version	string	Document version identifier

Example

{
  "document": {
    "metadata": {
      "title": "Q1 2026 Shipping Report",
      "author": "ShipForge Operations",
      "subject": "Quarterly performance metrics for North America corridor",
      "keywords": "shipping, logistics, Q1, 2026, North America",
      "version": "1.2"
    },
    "content": [
      { "p": "Report content goes here." }
    ]
  }
}

Where metadata appears

• PDF viewer title bar -- The title field is shown in the browser tab or PDF reader window title.
• Document properties dialog -- All fields are visible when viewing file properties (File > Properties in most PDF readers).
• Search indexing -- The keywords and subject fields help document management systems categorize and locate files.

Best practices

• Always set title for documents that will be shared or archived.
• Use keywords to improve discoverability in document management systems.
• Use version when generating multiple revisions of the same template to track which version produced a given PDF.