DocumentationAEM as a Cloud ServiceUser Guide

AEM Forms Communications APIs - Overview

Last update: Thu Feb 05 2026 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Applies to:
  • Experience Manager as a Cloud Service

CREATED FOR:

  • Developer
  • User

AEM Forms APIs provide a comprehensive suite of cloud-native APIs designed to help businesses automate document workflows.

AEM Forms APIs are structured and accessed through two primary consoles:

  • Adobe Developer Console (ADC) - Adobe Developer Console is the gateway to Adobe APIs, Events, Runtime and App Builder.

  • AEM Developer Console - AEM Developer Console provides access to environment-level details, configurations, technical accounts, and service credentials to support operational and integration tasks.

Different APIs support different authentication methods.

Authentication Methods

Different Forms APIs use different authentication methods based on their release timeline:

Earlier APIs support JWT-based server-to-server authentication, which is configured and managed through the AEM Developer Console. Newer APIs use OAuth Server-to-Server authentication and are configured through the Adobe Developer Console.

API Classification Overview

All AEM Forms APIs are divided into two main parts:

Details
Adaptive Form Delivery & Runtime APIs
Communication APIs
Purpose
Handle Adaptive Form delivery and runtime operations
Document generation and manipulation
Use Cases
- Form rendering
- Data prefill
- Form submissions
- Draft management
- PDF generation
- Document merging
- Batch processing
- Print operations
Authorization Method
Supports OAuth Server-to-Server / User authentication methods.
Supports server to server authentication, either JWT or OAuth depending on the API. An API cannot support both authnetication methood.

AEM Forms Communications APIs

Communication APIs are the primary focus for document-centric operations.

The table below lists all the AEM Forms Communications APIs along with their supported authentication methods and execution models:

Document Generation APIs

API Endpoint
Description
Execution Model
Authentication Method
/adobe/forms/batch/output/config
Creates a new batch configuration for document generation jobs.
Asynchronous/Batch
JWT
/adobe/forms/batch/output/config/{configName}
Retrieves details of a specific batch configuration.
Asynchronous/Batch
JWT
/adobe/forms/batch/output/config/configs
Returns a list of all available batch configurations.
Asynchronous/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution
Starts a batch output generation run using a configuration.
Asynchronous/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Retrieves the execution status of a batch job.
Asynchronous/Batch
JWT
/adobe/forms/batch/output/config/{configName}/executions
Lists all running instances for a specific batch configuration.
Asynchronous/Batch
JWT
/adobe/forms/doc/v1/generatePDFOutput
Generates PDF output synchronously based on templates and data.
Synchronous
JWT
/adobe/forms/doc/v1/generatePrintedOutput
Generates print-ready output formats (e.g., PCL, PostScript).
Synchronous
JWT
/adobe/forms/doc/v1/generate/afp
Generates AFP output for high-volume printing.
Synchronous
JWT
/adobe/document/generate/pdfform
Renders a PDF Form (XFA/XDP) with merged data.
Synchronous
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
Retrieves the status of a PDF form generation job.
Synchronous
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
Fetches the output/result of a completed PDF form job.
Synchronous
OAuth

Document Manipulation APIs

API Endpoint
Description
Execution Model
Authentication Method
/adobe/forms/assembler/ddx/invoke
Executes DDX instructions to combine, split, or manipulate PDFs.
Synchronous
JWT
/adobe/forms/assembler/pdfa/convert
Converts a PDF document to PDF/A format.
Synchronous
JWT
/adobe/forms/assembler/pdfa/validate
Validates whether a PDF complies with PDF/A standard
Synchronous
JWT

Document Conversion APIs

API Endpoint
Description
Execution Model
Authentication Method
/adobe/document/convert/pdftoxdp
Converts a PDF form into XDP format.
Synchronous
OAuth

Document Extraction APIs

API Endpoint
Description
Execution Model
Authentication Method
/adobe/forms/doc/v1/extract/pdfproperties
Extracts properties and structural information from a PDF.
Synchronous
OAuth
/adobe/forms/doc/v1/extract/usagerights
Extracts usage rights embedded in a PDF.
Synchronous
OAuth
/adobe/forms/doc/v1/extract/metadata
Extracts metadata such as title, author, and keywords.
Synchronous
OAuth
/adobe/forms/doc/v1/extract/data
Extracts form data (XML/JSON) from PDF forms.
Synchronous
OAuth
/adobe/document/extract/security
Extracts security settings such as permissions and encryption.
Synchronous
OAuth

Document Transformation APIs

API Endpoint
Description
Execution Model
Authentication Method
/adobe/document/transform/metadata
Updates or adds metadata in a PDF document.
Synchronous
OAuth
/adobe/document/field/signature/add
Adds a digital signature field to a PDF.
Synchronous
OAuth
/adobe/document/field/signature/clear
Clears the contents of a signature field.
Synchronous
OAuth
/adobe/document/field/signature/remove
Removes a signature field from a PDF.
Synchronous
OAuth

Document Assurance APIs

API Endpoint
Description
Execution Model
Authentication Method
/adobe/document/assure/usagerights
Applies usage rights to a PDF (e.g., comment, fill, sign).
Synchronous
OAuth
/adobe/document/assure/encrypt
Encrypts a PDF with password or certificate security.
Synchronous
OAuth
/adobe/document/assure/decrypt
Decrypts a secured PDF document.
Synchronous
OAuth
/adobe/document/assure/sign
Digitally signs a PDF document.
Synchronous
OAuth
/adobe/document/assure/certify
Certifies a PDF with a digital certificate.
Synchronous
OAuth

Learn how to set environment for Synchronous (On-Demand) and Asynchronous (Batch) Forms Communications APIs:

Synchronous APIs

AEM Forms Communications APIs - Synchronous

Learn how to set up environment for Synchronous (on-demand) Forms Communications APIs that generate or process documents instantly.

Learn more

Asynchronous APIs

AEM Forms Communications APIs - Asynchronous (Batch)

Learn how to set up environment for Asynchronous (Batch) Forms Communications APIs that generate or process multiple documents in a scheduled manner.

Learn more

Related Articles
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab