Adobe PDF Services (Preview)

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. 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.

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)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Adobe Document Services
URL https://www.adobe.com/go/pdfservicesapi_forum
Connector Metadata
Publisher Adobe Inc.
Website https://www.adobe.com/go/dcsdk_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

  • 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/Linearize PDFs to reduce the file size for sharing in emails or quick viewing over web


Prerequisites

In order to use this connector you will need to obtain credentials by registering for a free trial or use a paid account for PDF Services API. Please see our pricing page for purchase options including pay as you go and volume discounts


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 trial account here.

Getting started with Adobe PDF Services

  • Step 2: After creating a free trial 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
    • Organization ID
    • Account ID
    • Base64 Encoded Private Key

Copy paste your generated credentials while creating your connection

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

PDF Services API offers a generous free trial to get started quickly and evaluate the actions for your business requirements. With your free trial you’ll receive 1000 PDF Transactions for up to 6 months, so you can evaluate all the PDF actions in different types of flows.

How to get paid credentials

After your free trial quota is exhausted, there are multiple purchase options available for different request volumes and budget needs. Please see our pricing page for purchase options including pay as you go and volume discounts.

Creating and setting up pay-as-you-go credentials

One of the purchase options for PDF Services API is a pay-as-you go subscription. Refer to our HelpX Page for instructions on how to subscribe, how to get and set-up new on Power Automate.

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:

Default Parameters for creating connection. All regions Shareable

Default

Applicable: All regions

Parameters for creating connection.

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/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 connection10060 seconds

Actions

Compress PDF (Preview)

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

Convert document to PDF (Preview)

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 (Preview)

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 (Preview)

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

Convert Image to PDF (Preview)

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

Convert PDF to Excel (Preview)

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

Convert PDF to Image (Preview)

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

Convert PDF to PPT (Preview)

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

Convert PDF to Word (Preview)

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

Convert PPT to PDF (Preview)

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

Convert Static HTML to PDF (Preview)

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 (Preview)

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

Create Searchable PDF using OCR (Preview)

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

Export PDF (Preview)

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

Generate document from Word template (Preview)

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

Linearize PDF (Preview)

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

Merge PDFs (Preview)

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

Protect PDF from Copying, Editing and Printing (Preview)

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

Protect PDF from Viewing (Preview)

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

Protect PDF with Access Permissions (Preview)

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 (Preview)

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

Split PDF (Preview)

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

Compress PDF (Preview)

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.

Returns

Convert document to PDF (Preview)

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.

Returns

Convert Dynamic HTML to PDF (Preview)

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

Returns

Convert Excel to PDF (Preview)

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.

Returns

Convert Image to PDF (Preview)

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.

Returns

Convert PDF to Excel (Preview)

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.

Returns

Convert PDF to Image (Preview)

Convert a PDF file to an image 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 .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.

Returns

Convert PDF to PPT (Preview)

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.

Returns

Convert PDF to Word (Preview)

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.

Returns

Convert PPT to PDF (Preview)

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.

Returns

Convert Static HTML to PDF (Preview)

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

Returns

Convert Word to PDF (Preview)

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.

Returns

Create Searchable PDF using OCR (Preview)

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.

Returns

Export PDF (Preview)

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.

Returns

Generate document from Word template (Preview)

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

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.

Template File Content
InputFile0 True contentOnly

The content of the source template file. Click Help icon to find more about sample templates.

Returns

Linearize PDF (Preview)

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.

Returns

Merge PDFs (Preview)

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.

File Content
Files byte

The content of the source PDF file.

Returns

Protect PDF from Copying, Editing and Printing (Preview)

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.

Returns

Protect PDF from Viewing (Preview)

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.

Returns

Protect PDF with Access Permissions (Preview)

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.

Returns

Remove Protection from PDF (Preview)

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.

Returns

Split PDF (Preview)

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 common separated fashion as 1-5,8-10.

File Content
InputFile0 True contentOnly

The content of the source file.

Returns

Definitions

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.