DocumentGenerationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-creative-suite/refs/heads/main/json-schema/adobe-creative-suite-pdf-services-document-generation-request-schema.json",
  "title": "DocumentGenerationRequest",
  "description": "Request body for generating a document from a template",
  "type": "object",
  "properties": {
    "assetID": {
      "type": "string",
      "description": "Asset ID of the Word document template",
      "example": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718"
    },
    "outputFormat": {
      "type": "string",
      "description": "Output format of the generated document",
      "enum": [
        "pdf",
        "docx"
      ],
      "example": "pdf"
    },
    "jsonDataForMerge": {
      "type": "object",
      "description": "JSON data object whose keys map to template tags in the document",
      "additionalProperties": true,
      "example": {
        "customerName": "John Doe",
        "invoiceDate": "2026-03-02",
        "totalAmount": 1500.0
      }
    },
    "notTaggedAdds": {
      "type": "boolean",
      "description": "Whether to include non-tagged content as plain text additions",
      "default": false,
      "example": true
    }
  },
  "required": [
    "assetID",
    "outputFormat",
    "jsonDataForMerge"
  ]
}