Adobe PDF Services

Adobe PDF Services API brings a set of powerful cloud-based APIs to integrate multi-step document workflows into any application. Use document generation to create custom PDF documents from Word templates and JSON data. Extract text, tables and images from PDFs in a structured JSON to enable downstream solutions. Convert to PDF, export PDF to other formats, apply OCR, compress, linearize or protect PDFs, and also edit PDFs with tools like merge or split. Auto-tag PDFs for better Accessibility.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   China Cloud operated by 21Vianet
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   China Cloud operated by 21Vianet

Contact
Name	Adobe Acrobat Services
URL	https://www.adobe.com/go/powerautomate_forum

Connector Metadata
Publisher	Adobe Inc.
Website	https://www.adobe.com/go/powerautomate_home
Privacy policy	https://www.adobe.com/privacy/policy.html
Categories	Content and Files;Data

Use Adobe PDF Services to automate PDF creation and manipulation in any flow without code. Build customized multi-step document workflows with over a dozen actions to complete any process.

Export PDFs to a variety of formats for data analysis and editing. Or create and manipulate PDFs, then send them out for signature with Adobe Sign in contract and agreement workflows.

Capabilities

• Create PDF documents from multiple formats including HTML, Microsoft Office, and more

• Generate rich and fully customizable documents from Word templates and JSON data, in PDF or Word format. Learn more about Document Generation in this webpage

• Extract all PDF document elements including text, tables, and images within a structured JSON file to enable a variety of downstream solutions.

• Export PDF documents to other formats such as Microsoft Office, text, and images

• OCR can be used to enable document search and text edit

• Protect PDF documents with a password, or remove it when no longer needed

• Merge multiple PDF documents into a single PDF, or Split a PDF into multiple documents

• Compress PDFs to reduce the file size, or Linearize PDF for quick viewing over web

• Get properties of a PDF document, such as size, page count and compliance level

• Tag PDF files to make them more accessible.

• Process your documents in the following region of your choice : Europe (Ireland) or US East (N.Virginia) - Default.

Prerequisites

In order to use this connector, you will need to obtain credentials by registering for a free Adobe account or use a paid account for PDF Services API. Please see our pricing page for purchase options and Enterprise Pricing.

How to get credentials

Getting started with Adobe PDF Services is easy with just a few steps:

Create a new trial account

• Step 1: Sign up for a free Adobe account here.

• Step 2: After creating a free Adobe account you’ll obtain your credentials which can be used for all PDF actions in your flows.

Setup your connection

• Step 3: Add your credentials to the Adobe PDF Services Connector. You can do this by copying these credential details to your one-time connection setup:

  • Client ID
  • Client Secret

Once you complete these steps, you can add any of the PDF Services Connector actions to your flow.

PDF Services API allows you to get started quickly for free so that you can evaluate all PDF actions for your business requirements in different types of flows. Learn more here

Please refer our HelpX Page for instructions on migration of existing Service Account (JWT) credentials and creation of new connections in existing flows.

How to get paid credentials

If you are interested in scaling your PDF Services API operations, you can visit our pricing page for purchase options and Enterprise Pricing.

Refer to our HelpX Page for instructions on how to access Adobe PDF Services connector on Power Automate interface.

Please Contact us for plans and pricing.

If you have any problems creating a connection, please reach out to us on our forums for help.

Creating a connection

The connector supports the following authentication types:

Oauth Server-to-Server Credentials	Log in using your clientId and clientSecret.	All regions	Shareable
JWT Service Account Credentials [Deprecated]	Log in using your clientId, clientSecret, privateKey, accountId and orgId. [Deprecated]	All regions	Shareable
Default [DEPRECATED]	This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.	All regions	Not shareable

Oauth Server-to-Server Credentials

Auth ID: OauthSimplifiedCreds

Applicable: All regions

Log in using your clientId and clientSecret.

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name	Type	Description	Required
Client Id – Create new credentials by visiting https://www.adobe.com/go/getstarted_powerautomate	string	Please enter the client Id	True
Client Secret	securestring	Please enter the client Secret	True

JWT Service Account Credentials [Deprecated]

Auth ID: JWTServiceAcct

Applicable: All regions

Log in using your clientId, clientSecret, privateKey, accountId and orgId. [Deprecated]

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name	Type	Description	Required
Client Id [Deprecated]	string	Please enter the client Id. [Deprecated]	True
Client Secret [Deprecated]	securestring	Please enter the client secret. [Deprecated]	True
Organization Id [Deprecated]	string	Please enter your registered organization Id. [Deprecated]	True
Technical Account Id [Deprecated]	string	Please enter your registered technical account Id. [Deprecated]	True
Base64 Encoded Private Key [Deprecated]	securestring	Please enter the base64 encoded private key associated with your credentials. [Deprecated]	True

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Client Id – Create new credentials by visiting https://www.adobe.com/go/powerautomate_getstarted	string	Please enter the client Id.	True
Client Secret	securestring	Please enter the client secret.	True
Organization Id	string	Please enter your registered organization Id.	True
Technical Account Id	string	Please enter your registered technical account Id.	True
Base64 Encoded Private Key	securestring	Please enter the base64 encoded private key associated with your credentials.	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	250	60 seconds

Actions

Compress PDF	Compress a PDF file. Only files with .pdf extension are supported.
Convert document to PDF	Convert a file to PDF format. Only files with .doc, .docx, .ppt, .pptx, .xls, .xlsx, .bmp, .gif, .jpeg, .jpg, .png, .rtf, .tif, .tiff or .txt extension are supported.
Convert Dynamic HTML to PDF	Convert a Dynamic HTML file to PDF format. Since HTML/web pages typically contain external assets, the input file must be a zip file containing an index.html at the top level of the archive, as well as any dependencies such as images, css files, and so on. Only files with .zip extension are supported.
Convert Excel to PDF	Convert an Excel file to PDF format. Only files with .xls or .xlsx extension are supported.
Convert Image to PDF	Convert an image file to PDF format. Only files with .png, .jpeg, .jpg, .tiff, .tif or .gif extension are supported.
Convert PDF to Excel	Convert a PDF file to an Excel file. Only files with .pdf extension are supported.
Convert PDF to Image	Convert a PDF file to a zip of images. Only files with .pdf extension are supported.
Convert PDF to List Of Images	Convert a PDF file to a list of images. Only files with .pdf extension are supported.
Convert PDF to PPT	Convert a PDF file to PPT. Only files with .pdf extension are supported.
Convert PDF to Word	Convert a PDF file to a Word file. Only files with .pdf extension are supported.
Convert PPT to PDF	Convert a PPT file to PDF format. Only files with .ppt or .pptx extension are supported.
Convert Static HTML to PDF	Convert a static HTML file to PDF format. Since HTML/web pages typically contain external assets, the input file must be a zip file containing an index.html at the top level of the archive, as well as any dependencies such as images, css files, and so on. Only files with .zip extension are supported.
Convert Word to PDF	Convert a Word file to PDF format. Only files with .doc or .docx extension are supported.
Create Searchable PDF using OCR	OCR a PDF file. Only files with .pdf extension are supported.
Create tagged PDF	Add tags to PDF documents to make them more accessible. All tags from the input file will be removed, except for existing alt-text images, and a new tagged PDF file will be created as output. Accessibility tags, used by assistive technology such as screen readers, are required to make PDF files compliant. However, the output is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA, as you may need to perform further downstream remediation to meet those standards.
Export PDF	Convert a PDF file to various formats. The supported output formats are .doc, .docx, .jpeg, .png, .pptx, .rtf and .xlsx.
Extract Images From PDF	Extracts Images from a PDF Document. Only files with .pdf extension are supported.
Extract PDF Structure, Tables and Images from a PDF	Extract PDF structure and content elements, incl. Tables and Images, from PDF Document. Only files with .pdf extension are supported.
Extract PDF Structure in a JSON File	Extract PDF Structure in a JSON File. Only files with .pdf extension are supported.
Extract PDF Structure in a JSON Object	Extract PDF Structure in a JSON Object. Only files with .pdf extension are supported.
Extract Tables from PDF	Extracts Tables in .xlsx format from a PDF Document. Only files with .pdf extension are supported.
Generate document from Word template	Replaces merge fields in a DOCX template document with specified JSON data. The keys in data object should be the same as names of merge fields in document. Template documents can be authored using Adobe Document Generation Word Add-in. Find the add-in and Word templates at: https://adobe.com/go/dcdocgen_home. Detailed documentation for the Document Generation API can be found at: https://adobe.com/go/dcdocgen_overview_doc
Get PDF Properties	Get Properties of a PDF Document. Only files with .pdf extension are supported.
Linearize PDF	Linearize a PDF file. Only files with .pdf extension are supported.
Merge PDFs	Merge PDF files into a single file. Only files with .pdf extension are supported.
Protect PDF from Copying, Editing and Printing	Protect a PDF document from copying, editing & printing. Only files with .pdf extension are supported.
Protect PDF from Viewing	Protect a PDF document from viewing. Only files with .pdf extension are supported.
Protect PDF with Access Permissions	Protect a PDF document from Viewing and other Accesses like Editing, Copying and Printing. Only files with .pdf extension are supported.
Remove Protection from PDF	Remove password and security & permissions from the protected document. Only files with .pdf extension are supported.
Split PDF	Split a PDF Document into multiple PDF Documents. Only files with .pdf extension are supported.

Compress PDF

Operation ID:

CompressPDF

Compress a PDF file. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The name of the compressed PDF file. If it is not provided, source file name with .pdf extension will be used.
Compression Level	compressionLevel		string	The level of compression required. The default is MEDIUM.
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CompressPDFResponse

Convert document to PDF

Operation ID:

CreatePDFGeneric

Convert a file to PDF format. Only files with .doc, .docx, .ppt, .pptx, .xls, .xlsx, .bmp, .gif, .jpeg, .jpg, .png, .rtf, .tif, .tiff or .txt extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Convert Dynamic HTML to PDF

Operation ID:

CreatePDFFromDynamicHtml

Convert a Dynamic HTML file to PDF format. Since HTML/web pages typically contain external assets, the input file must be a zip file containing an index.html at the top level of the archive, as well as any dependencies such as images, css files, and so on. Only files with .zip extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
Page Size	pageSize	True	string	The page size for the output PDF document, A4 is the default size.
Include Header Footer	includeHeaderFooter		boolean	Header/Footer to be included in pdf or not
Merge Data Json	dataToMerge		string	The Json object containing key value pair to replaced in the output pdf.
File Content	InputFile0	True	contentOnly	The content of the source zip file containing index.html
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Convert Excel to PDF

Operation ID:

CreatePDFFromExcel

Convert an Excel file to PDF format. Only files with .xls or .xlsx extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Convert Image to PDF

Operation ID:

CreatePDFFromImage

Convert an image file to PDF format. Only files with .png, .jpeg, .jpg, .tiff, .tif or .gif extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Convert PDF to Excel

Operation ID:

ExportPDFToExcel

Convert a PDF file to an Excel file. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name with .xlsx extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ExportDocumentResponse

Convert PDF to Image

Operation ID:

ExportPDFToImage

Convert a PDF file to a zip of images. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name with .jpeg/.png extension will be used.
Output Format	targetFormat	True	string	The output format to which PDF is to be converted. The default is JPEG.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ExportDocumentResponse

Convert PDF to List Of Images

Operation ID:

ExportPDFToImageList

Convert a PDF file to a list of images. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name with .jpeg/.png extension will be used.
Output Format	targetFormat	True	string	The output format to which PDF is to be converted. The default is JPEG.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseExportedImages

Convert PDF to PPT

Operation ID:

ExportPDFToPPT

Convert a PDF file to PPT. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name with .pptx extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ExportDocumentResponse

Convert PDF to Word

Operation ID:

ExportPDFToWord

Convert a PDF file to a Word file. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name with .docx extension will be used.
Output Format	targetFormat	True	string	The output format to which PDF is to be converted. The default is docx.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ExportDocumentResponse

Convert PPT to PDF

Operation ID:

CreatePDFFromPPT

Convert a PPT file to PDF format. Only files with .ppt or .pptx extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Convert Static HTML to PDF

Operation ID:

CreatePDFFromStaticHtml

Convert a static HTML file to PDF format. Since HTML/web pages typically contain external assets, the input file must be a zip file containing an index.html at the top level of the archive, as well as any dependencies such as images, css files, and so on. Only files with .zip extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
Page Size	pageSize	True	string	The page size for the output PDF document, A4 is the default size.
Include Header Footer	includeHeaderFooter		boolean	Header/Footer to be included in pdf or not
File Content	InputFile0	True	contentOnly	The content of the source zip file containing index.html
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Convert Word to PDF

Operation ID:

CreatePDFFromWord

Convert a Word file to PDF format. Only files with .doc or .docx extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
PDF File Name	outputFileName		string	The name of the converted PDF file. If it is not provided, source file name with .pdf extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CreatePDFResponse

Create Searchable PDF using OCR

Operation ID:

OcrPDF

OCR a PDF file. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
File Locale	ocrLocale	True	string	The locale of the source PDF file.
Searchable Options	ocrType	True	string	The searchable option for OCR.
PDF File Name	outputFileName		string	The name of the output PDF file. If it is not provided, source file name with .pdf extension will be used.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

OCRPDFResponse

Create tagged PDF

Operation ID:

AutoTag

Add tags to PDF documents to make them more accessible. All tags from the input file will be removed, except for existing alt-text images, and a new tagged PDF file will be created as output. Accessibility tags, used by assistive technology such as screen readers, are required to make PDF files compliant. However, the output is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA, as you may need to perform further downstream remediation to meet those standards.

Parameters

Name	Key	Required	Type	Description
Input File Name	inputFileName	True	string	The name of the input file with extension.
File Content	fileData	True	contentOnly	The content of the input file.
Generate Report in XLS Format	generateReport	True	boolean	Generate Report in XLS Format
Shift Headings in PDF	shiftHeadings	True	boolean	Shift Headings in PDF
Output File Name	outputFileName		string	The name of the output file with extension.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseAutotagPDF

Export PDF

Operation ID:

ExportPDFGeneric

Convert a PDF file to various formats. The supported output formats are .doc, .docx, .jpeg, .png, .pptx, .rtf and .xlsx.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name will be used.
Output Format	targetFormat	True	string	The output format to which PDF is to be converted.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ExportDocumentResponse

Extract Images From PDF

Operation ID:

ExtractImagesFromPDF

Extracts Images from a PDF Document. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseExtractImages

Extract PDF Structure, Tables and Images from a PDF

Operation ID:

ExtractJSONAndImagesAndTablesFromPDF

Extract PDF structure and content elements, incl. Tables and Images, from PDF Document. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
Extract Tables?	addTables	True	boolean	Table Renditions to be included or not. Default is true.
Extract Images?	addFigures	True	boolean	Figure Renditions to be included or not. Default is true.
Output Format of the PDF Structure	pdfStructureOutputFormat	True	string	The PDF Structure in a JSON Object or a JSON File. By default, PDF Structure will extracted in a JSON File.
Add Character Information	addCharInfo		boolean	Character Information to be included or not. Default is true.
Get Styling Information	getStylingInfo		boolean	Styling Information to be included or not. Default is true.
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseExtractDocument

Extract PDF Structure in a JSON File

Operation ID:

ExtractJSONFileFromPDF

Extract PDF Structure in a JSON File. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
Add Character Information	addCharInfo		boolean	Character Information to be included or not. Default is true.
Get Styling Information	getStylingInfo		boolean	Styling Information to be included or not. Default is true.
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseExtractJSONFile

Extract PDF Structure in a JSON Object

Operation ID:

ExtractJSONObjectFromPDF

Extract PDF Structure in a JSON Object. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
Add Character Information	addCharInfo		boolean	Character Information to be included or not. Default is true.
Get Styling Information	getStylingInfo		boolean	Styling Information to be included or not. Default is true.
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseExtractJsonObject

Extract Tables from PDF

Operation ID:

ExtractTablesFromPDF

Extracts Tables in .xlsx format from a PDF Document. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseExtractTables

Generate document from Word template

Operation ID:

DocGen

Replaces merge fields in a DOCX template document with specified JSON data. The keys in data object should be the same as names of merge fields in document. Template documents can be authored using Adobe Document Generation Word Add-in. Find the add-in and Word templates at: https://adobe.com/go/dcdocgen_home. Detailed documentation for the Document Generation API can be found at: https://adobe.com/go/dcdocgen_overview_doc

Parameters

Name	Key	Required	Type	Description
Template File Name	inputFileName	True	string	The name of the source template file with extension.
Merge Data	jsonStringForMerge	True	string	JSON data that should be applied to the template. Click Help icon to know how to use json for authoring template and generating document.
Output Format	targetFormat	True	string	The output format in which file is to be generated. The default is PDF.
Output File Name	outputFileName		string	The file name of the output file. If it is not provided, source file name with targetFormat extension will be used.
Fragments	fragments		string	JSON data with the fragments to be included in the document template. Provide a JSON object containing all the fragments. To learn more, see https://www.adobe.com/go/dcdocgen_fragments_support
Template File Content	InputFile0	True	contentOnly	The content of the source template file. Click Help icon to find more about sample templates.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DocGenResponse

Get PDF Properties

Operation ID:

PDFProperties

Get Properties of a PDF Document. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
Input File Name	inputFileName	True	string	The name of the source file with extension.
Input File Content	InputFile0	True	contentOnly	The content of the source file.
Get Page Level Properties	pageLevel	True	boolean	Get page level properties
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponsePDFProperties

Linearize PDF

Operation ID:

LinearizePDF

Linearize a PDF file. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The name of the linearized PDF file. If it is not provided, source file name with .pdf extension will be used.
File Name	inputFileName	True	string	The name of the source file with extension.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

LinearizePDFResponse

Merge PDFs

Operation ID:

CombinePDF

Merge PDF files into a single file. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
Merged PDF File Name	outputFileName	True	string	The name of the merged PDF file.
Files	files	True	array of byte	The array of file contents.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

CombinePDFResponse

Protect PDF from Copying, Editing and Printing

Operation ID:

ProtectOwnerPDF

Protect a PDF document from copying, editing & printing. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The name of the protected PDF file. If it is not provided, source file name with .pdf extension will be used.
File Name	inputFileName	True	string	The name of the source file with extension.
Password	ownerPassword	True	string	The password that will be required for access permissions.
Encryption Level	contentEncryption	True	string	The encryption level that will be used to set the password.
Allow Low Quality Printing?	allowPrintLowQuality	True	boolean	Enables low quality printing of the PDF document.
Allow High Quality Printing?	allowPrintHighQuality	True	boolean	Enables high quality printing of the PDF document. If set to true, low quality printing would be allowed as well.
Allow Content Editing?	allowEditContent	True	boolean	Enables all the editing permissions in the PDF document except commenting and page extraction. If set to true, document assembly and fill & sign form fields editing would be allowed as well.
Allow Document Assembly Editing?	allowEditDocumentAssembly	True	boolean	Enables insertion, deletion and rotation of pages in a PDF document.
Allow Annotations Editing?	allowEditAnnotations	True	boolean	Enables additions of comments, digital signatures and filling in of forms in a PDF document.
Allow Fill & Sign Form Fields Editing?	allowEditFillAndSignFormFields	True	boolean	Enables filling in of forms, digital signature and creation of template pages in a PDF document.
Allow Content Copying?	allowCopyContent	True	boolean	Enables copying of content from the PDF document.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ProtectPDFResponse

Protect PDF from Viewing

Operation ID:

ProtectUserPDF

Protect a PDF document from viewing. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The name of the protected PDF file. If it is not provided, source file name with .pdf extension will be used.
File Name	inputFileName	True	string	The name of the source file with extension.
Password	userPassword	True	string	The password that will be set on the PDF document.
Encryption Level	contentEncryption	True	string	The encryption level that will be used to set the password.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ProtectPDFResponse

Protect PDF with Access Permissions

Operation ID:

ProtectGenericPDF

Protect a PDF document from Viewing and other Accesses like Editing, Copying and Printing. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The name of the protected PDF file. If it is not provided, source file name with .pdf extension will be used.
File Name	inputFileName	True	string	The name of the source file with extension.
Viewing Password	userPassword	True	string	The password that will be required to view the PDF document.
Editing, Copying, Printing Password	ownerPassword	True	string	The password that will be required for access permissions.
Encryption Level	contentEncryption	True	string	The encryption level that will be used to set the password.
Allow Low Quality Printing?	allowPrintLowQuality	True	boolean	Enables low quality printing of the PDF document.
Allow High Quality Printing?	allowPrintHighQuality	True	boolean	Enables high quality printing of the PDF document. If set to true, low quality printing would be allowed as well.
Allow Content Editing?	allowEditContent	True	boolean	Enables all the editing permissions in the PDF document except commenting and page extraction. If set to true, document assembly and fill & sign form fields editing would be allowed as well.
Allow Document Assembly Editing?	allowEditDocumentAssembly	True	boolean	Enables insertion, deletion and rotation of pages in a PDF document.
Allow Annotations Editing?	allowEditAnnotations	True	boolean	Enables additions of comments, digital signatures and filling in of forms in a PDF document.
Allow Fill & Sign Form Fields Editing?	allowEditFillAndSignFormFields	True	boolean	Enables filling in of forms, digital signature and creation of template pages in a PDF document.
Allow Content Copying?	allowCopyContent	True	boolean	Enables copying of content from the PDF document.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

ProtectPDFResponse

Remove Protection from PDF

Operation ID:

RemovePassword

Remove password and security & permissions from the protected document. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The file name of the output PDF file. If it is not provided, source file name will be used.
File Name	inputFileName	True	string	The name of the source file with extension.
Password	password	True	string	The password set on the document.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

UnProtectPDFResponse

Split PDF

Operation ID:

SplitPDF

Split a PDF Document into multiple PDF Documents. Only files with .pdf extension are supported.

Parameters

Name	Key	Required	Type	Description
PDF File Name	outputFileName		string	The name of the split PDF file. If it is not provided, source file name with .pdf extension will be used.
File Name	inputFileName	True	string	The name of the source file with extension.
Split Type	splitByType	True	string	Select how to split the file
Split Configuration	splitConfiguration	True	string	Please provide the split configuration. For Page Range Array, provide array elements in a comma separated fashion as 1-5,8-10.
File Content	InputFile0	True	contentOnly	The content of the source file.
Region	x-region-value		string	Region configuration where document needs to be processed. US East (N. Virginia) is the default region.

Returns

Body

DtoResponseSplitDocument

Definitions

DtoResponsePDFProperties

Name	Path	Type	Description
File Name	fileName	string	The name of the PDF Properties JSON file.
File Content	fileContent	byte	The file stream of the PDF Properties JSON file.
File Content Type	fileContentType	string	The content type of the PDF Properties JSON file.
JSON String	jsonObject	string	All the PDF Properties in JSON Format
PDF Page Count	properties.page_count	integer	Number of pages in PDF Document
File Size	properties.file_size	string	Size of PDF Document
PDF Linearized	properties.linearized	boolean	Whether the PDF is linearized (T) or not (F)
PDF Tagged	properties.tagged	boolean	Whether the PDF is tagged (T) or not (F)
PDF Certified	properties.certified	boolean	Whether the PDF is certified (T) or not (F)
PDF XFA	properties.xfa	boolean	Whether the PDF is an XFA form (T) or not (F)
PDF Portfolio	properties.portfolio	boolean	Whether the PDF is a portfolio (T) or not (F)
PDF Encrypted	properties.encrypted	boolean	Whether the PDF is encrypted (T) or not (F)
PDF Version	properties.pdfVersion	string	Version of PDF Document
PDF Has Acroforms	properties.hasAcroForms	boolean	Whether the PDF has Acroforms (T) or not (F)
PDF Signed	properties.signed	boolean	Whether the PDF is signed (T) or not (F)
Incremental Save Count	properties.incrementalSaveCount	integer	PDF's Incremental save count
PDF Has Embedded Files	properties.hasEmbeddedFiles	boolean	Whether the PDF has embedded files (T) or not (F)
XMP	properties.XMP	string	XMP Details
PDF Creation Date	properties.creationDate	string	Creation Date of PDF
PDF Producer	properties.Producer	string	Producer of the PDF
PDF Latest Modification Date	properties.modifiedDate	string	Latest Modification Date of PDF
Fonts :	properties.fonts	array of DtoResponsePDFPropertiesFonts	Array with Font information for PDF
PDF/A Compliance Level	properties.pdfa_compliance_level	string	PDF/A Compliance Level
PDF/E Compliance Level	properties.pdfe_compliance_level	string	PDF/E Compliance Level
PDF/VT Compliance Level	properties.pdfvt_compliance_level	string	PDF/VT Compliance Level
PDF/X Compliance Level	properties.pdfx_compliance_level	string	PDF/X Compliance Level
PDF/UA Compliance Level	properties.pdfua_compliance_level	string	PDF/UA Compliance Level
Page :	properties.pages	array of DtoResponsePDFPropertiesPages	Array of properties for each page in the PDF

DtoResponseAutotagPDF

Name	Path	Type	Description
File Name	fileName	string	The name of the output file.
File Content	fileContent	byte	The file stream of the output file.
File Content Type	fileContentType	string	The content type of the output file.

DtoResponsePDFPropertiesFonts

Name	Path	Type	Description
Font Name	name	string	Font Name
Font Type	font_type	string	Font Type
Font Family Name	family_name	string	Font Family Name

DtoResponsePDFPropertiesPages

Name	Path	Type	Description
Page Number	pageNumber	integer	Page Number
Page Scanned	scanned	boolean	Whether the page is scanned (T) or not (F)
Page Width	width	integer	Width of the PDF Page
Page Height	height	integer	Height of the PDF Page
Page Has Structure	hasStructure	boolean	Whether the page has structure (T) or not (F)
Number of images in the page	numberOfImages	integer	Number of images in the page
Only Images in the page	onlyImages	boolean	Whether the page only has images (T) or not (F)
Page has text	hasText	boolean	Whether the page has text (T) or not (F)
Page has Images	hasImages	boolean	Whether the page has images (T) or not (F)
Page empty	empty	boolean	Whether the page is empty (T) or not (F)

DtoResponseExportedImages

Name	Path	Type	Description
Image List	documents	array of ExportDocumentResponse	The array of documents.

DtoResponseExtractDocument

Name	Path	Type	Description
Extracted File Name	jsonFileName	string	The name of the extracted JSON file.
Extracted File Content	jsonFileContent	byte	The content of the extracted JSON file.
Extracted File Content Type	jsonFileContentType	string	The content type of the extracted JSON file.
Extracted PDF Structure	structuredJsonObject	string	The PDF Structure in a JSON Object
Images	images	array of ImageObject	The array of Images extracted from the PDF
Tables	tables	array of TableObject	The array of Tables ( in .xlsx format ) extracted from the PDF

ImageObject

Name	Path	Type	Description
File Name	fileName	string	The name of the Image file.
File Content	fileContent	byte	The content of the Image file.
File Content Type	fileContentType	string	The content type of the Image file.

TableObject

Name	Path	Type	Description
File Name	fileName	string	The name of the xlsx file
File Content	fileContent	byte	The content of the xlsx file
File Content Type	fileContentType	string	The content type of the xlsx file

DtoResponseExtractImages

Name	Path	Type	Description
Images	images	array of ImageObject	The array of Images extracted from the PDF

DtoResponseExtractTables

Name	Path	Type	Description
Tables	tables	array of TableObject	The array of Tables ( in .xlsx format ) extracted from the PDF

DtoResponseExtractJSONFile

Name	Path	Type	Description
Extracted File Name	jsonFileName	string	The name of the extracted JSON file.
Extracted File Content	jsonFileContent	byte	The content of the extracted JSON file.
Extracted File Content Type	jsonFileContentType	string	The content type of the extracted JSON file.

DtoResponseExtractJsonObject

Name	Path	Type	Description
Extracted PDF Structure	structuredJsonObject	string	The PDF Structure in a JSON Object

DtoResponseSplitDocument

Name	Path	Type	Description
Split Document	documents	array of DocumentObject	The array of split documents.

CreatePDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the converted PDF file.
PDF File Content	fileContent	byte	The file stream of the converted PDF file.
PDF File Content Type	fileContentType	string	The content type of the converted PDF file.

LinearizePDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the linearized PDF file.
PDF File Content	fileContent	byte	The file stream of the linearized PDF file.
PDF File Content Type	fileContentType	string	The content type of the linearized PDF file.

CompressPDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the compressed PDF file.
PDF File Content	fileContent	byte	The file stream of the compressed PDF file.
PDF File Content Type	fileContentType	string	The content type of the compressed PDF file.

CombinePDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the merged PDF file.
PDF File Content	fileContent	byte	The file stream of the merged PDF file.
PDF File Content Type	fileContentType	string	The content type of the merged PDF file.

OCRPDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the output PDF file.
PDF File Content	fileContent	byte	The file stream of the output PDF file.
PDF File Content Type	fileContentType	string	The content type of the output PDF file.

ProtectPDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the protected PDF file.
PDF File Content	fileContent	byte	The file stream of the protected PDF file.
PDF File Content Type	fileContentType	string	The content type of the protected PDF file.

UnProtectPDFResponse

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the output PDF file.
PDF File Content	fileContent	byte	The file stream of the output PDF file.
PDF File Content Type	fileContentType	string	The content type of the output PDF file.

ExportDocumentResponse

Name	Path	Type	Description
Output File Name	fileName	string	The name of the converted file.
Output File Content	fileContent	byte	The file stream of the converted file.
Output File Content Type	fileContentType	string	The content type of the converted file.

DocGenResponse

Name	Path	Type	Description
Output File Name	fileName	string	The name of the converted file.
Output File Content	fileContent	byte	The file stream of the converted file.
Output File Content Type	fileContentType	string	The content type of the converted file.

DocumentObject

Name	Path	Type	Description
PDF File Name	fileName	string	The name of the split PDF file.
File Content	fileContent	byte	The file stream of the split PDF file.
File Content Type	fileContentType	string	The content type of the split PDF file.