Billable Document Services APIs

Generate PDF Service

APIDescriptionTransaction report categoryAdditional Information
createPDFCreates Adobe PDF from supported file types.Documents Processed
createPDF2Creates Adobe PDF from supported file types.Documents Processed
exportPDFConverts Adobe PDF to supported file types.Documents Processed
exportPDF2Converts Adobe PDF to supported file types.Documents Processed
exportPDF3Converts Adobe PDF to supported file types.Documents Processed
htmlFileToPdfCreates PDF from HTML pages.Documents Processed
htmlToPdfCreates PDF from URLs pointing to an HTML page.Documents Processed
htmlToPdf2Creates PDF from URLs pointing to an HTML page.Documents Processed
optimizePDFOptimizes PDF to reduce file size by stripping unnecessary metadata without affecting the quality.Documents Processed

DocAssurance Service

APIDescriptionTransaction report categoryAdditional Information
secureDocumentThis API enables you to secure your document. You can use the API to sign, certify, reader extend, or encrypt a PDF document.Documents ProcessedOnly sign and certify operation of the secureDocument are billed.

Distiller Service

APIDescriptionTransaction report categoryAdditional Information
createPDFCreates Adobe PDF from supported file types.Documents Processed
createPDF2Creates Adobe PDF from supported file types.Documents Processed

Document of Record Service (DoR Service)

APIDescriptionTransaction report categoryAdditional Information
renderInvokes the specified render method to generate a document of record using provided parameters.Documents Processed

Output Service

APIDescriptionTransaction report categoryAdditional Information
generatePDFOutputMerges data and templates to create a PDF document.Documents Processed
generatePDFOutputMerges data and templates to create a PDF document.Documents Processed
generatePDFOutputBatchMerges data and templates to create a set of PDF documents.Documents ProcessedThe generatePDFOutputBatch API combines a form template with a record and generates a PDF. When you process a batch of records, the transaction reporting service counts each record as a separate PDF rendition.
You can use the getGenerateManyFiles flag to combine multiple renditions to single PDF file. Irrespective of the status of flag, the service counts each record as a separate PDF rendition.
generatePrintedOutputConverts XDP and PDF documents to PostScript (PS), Printer Command Language (PCL), and ZPL file formats.Documents Processed
generatePrintedOutputConverts XDP and PDF documents to PostScript (PS), Printer Command Language (PCL), and ZPL file formats.Documents Processed
generatePrintedOutputBatchConverts a set of XDP and PDF documents to a set of PostScript (PS), Printer Command Language (PCL), and ZPL file formats.Documents ProcessedThe generatePDFOutputBatch API combines a form template with a record and generates a PDF. When you process a batch of records, the transaction reporting service counts each record as a separate PDF rendition.
You can use the getGenerateManyFiles flag to combine multiple renditions to single PDF file. Irrespective of the status of flag, the service counts each record as a separate PDF rendition.

Forms Service

APIDescriptionTransaction report categoryAdditional Information
renderPDFFormRenders PDF Form from XDP templates. The XP templates are created in Forms Designer.Documents Processed
exportDataExtracts data from a PDF Form or XDP templatesDocuments Processed

Convert PDF Service

APIDescriptionTransaction report categoryAdditional Information
toImageConverts a PDF document to a list of image documents. Supported image formats are JPEG, JPEG2K, PNG, and TIFF.Documents Processed
toPSConverts a Flat PDF file to PostScript format using the options specified in the option spec.Documents Processed

Barcoded Forms Service

APIDescriptionTransaction report categoryAdditional Information
decodeDecodes all the barcodes in a Document object and returns an org.w3c.dom.Document object that contains data that was retrieved from the barcode.Documents Processed

Assembler Service

APIDescriptionTransaction report categoryAdditional Information
invokeExecutes the specified DDX document and returns an AssemblerResult object containing the resultant documents.Documents Processed

The following operations are not accounted as transactions:

  • Creating packages or portfolio
  • Stitching multiple XDPs
invokeExecutes the specified DDX document and returns an AssemblerResult object containing the resultant documents.Documents ProcessedAll the input file formats that PDF Generator, Forms, and Output services support, Assembler service supports all those formats as output file formats.
toPDFAConvert a specified document to PDF/A using the options specified.Documents Processed

The invoke API’s usage is counted as a transaction, when you perform one or more of the following operations:

  1. Conversion from non-PDF formats to PDF formats. For instance, the conversion from XDP format to PDF format, catering to both interactive and non-interactive forms of communication, and the conversion from Word to PDF.
  2. Conversion from PDF format to PDF/A format.
  3. Conversion from PDF format to non-PDF formats. Examples encompass the transformation from PDF to Image format or the conversion from PDF to Text format.
NOTE
  • The invoke API of the assembler service can internally call a billable API of another service depending on the input. So, the invoke API can be accounted as none, single, or multiple transactions. The number of transactions counted depends upon the input and the internal APIs invoked.
  • A single PDF document produced using assembler service can be accounted as none, single, or multiple transactions. The number of transactions counted depends upon the supplied DDX code.

PDF Utility Service

APIDescriptionTransaction report categoryAdditional Information
convertPDFtoXDPConverts a PDF document into an XDP file. For a PDF document to be successfully converted to an XDP file, the PDF document must contain an XFA stream in the AcroForm dictionary.Documents Processed

Billable Data Capture APIs

All the submission events of adaptive forms, HTML5 Forms, and form set are accounted as transactions. By default, submission of a PDF Form is not accounted as a transaction. Use the provided transaction recorder API to record a PDF Forms submission as a transaction.

Adaptive Forms

Use CaseDescriptionTransaction report categoryAdditional Information
Submitting an adaptive formSubmits an adaptive form to configured submit action.Forms Submitted
  • Successful submissions account for single or two transactions. The number of transactions counted depends upon the type of submit action used for submission. For example, sending PDF through email submit action accounts for two counts of transactions. One transaction for form submission and another for PDF generated using the Document of Record (DOR) service.
  • Using the adaptive form within an adaptive form (Adaptive form formset) accounts only single transaction. You can have any number of adaptive forms within an adaptive form.

HTML5 Forms

Use CaseDescriptionTransaction report categoryAdditional Information
Submitting an HTML5 FormSubmits an HTML5 Form to submit URL configured in the form.Forms Submitted

Form set

APIDescriptionTransaction report categoryAdditional Information
Submitting a form setSubmits form set to the submit URL configured in the form set.Forms Submitted
  • Using the adaptive form within an adaptive form (Adaptive form formset) accounts only single transaction. You can have any number of adaptive forms within an adaptive form.
  • Every form in an HTML5 Forms form set accounts as a separate transaction.

Billable Interactive Communication and Form-centric AEM Workflows on OSGi APIs

Assign task and document services steps of Form-centric AEM Workflows on OSGi and all the renditions of interactive communication and are accounted as transactions. Previewing an interactive communication on the author instance and previewing on the publish instance using Agent UI are not accounted as transactions. If a workflow step accounts a transaction and the workflow fails to complete, the transaction count is not reversed.

Interactive Communication - Web Channel

APIDescriptionTransaction report categoryAdditional Information
Rendering a web channelOpens the web version of an interactive communication.Documents Rendered

Interactive Communication - Print Channel

APIDescriptionTransaction report categoryAdditional Information
render (convert to PDF)Generates the PDF version of an interactive communication.Documents Rendered

Form-centric AEM Workflows on OSGi

Use caseTransaction report categoryAdditional Information
Submitting an Assign Task stepForms Submitted
Submitting a workflow application startpointForms Submitted
Submitting an interactive communication (Print Channel) from the Agent UI to a workflowDocuments Rendered

Recording billable APIs as transactions for custom code

Actions like submitting a PDF Form, using Agent UI to preview an interactive communication, using non-standard form submission, and custom implementations are not accounted as transactions. AEM Forms provides an API to record such actions as transactions. You can call the API from your custom implementations to record a transaction.

Experience Manager


Espressos & Experience Manager: AEM Forms

Espressos & Experience Manager

Thursday, Mar 6, 7:00 PM UTC

Join Adobe's AEM product team as they highlight AEM Forms' latest innovations, including: the new Gen AI Assistant, Unified Composition with AEM Sites, and new ways to deploy forms through conversations.

Register

Elevate and Empower Teams with Agentic AI for Exceptional Experiences

Online | Strategy Keynote | General Audience

Elevate and empower your CX teams with AI that transforms creativity, personalization, and productivity. Discover how Adobe is...

Tue, Mar 18, 1:00 PM PDT (8:00 PM UTC)

Register

The Future of Forms: Experience Success Across the Enrollment Journey

Online | Session | General Audience

Adobe Experience Manager Forms is the conversion engine to fully capitalize on engagement and personalization efforts, yet it’s frequently...

Wed, Mar 19, 2:00 PM PDT (9:00 PM UTC)

Register

Connect with Experience League at Summit!

Get front-row access to top sessions, hands-on activities, and networking—wherever you are!

Learn more