PDF4me Connect
PDF4me gives you all functionalities around PDF, e.g. convert, merge, split, make PDF/A compatible, optimize, protect, unlock, do OCR, create watermarks, create images, rotate PDF, attach barcodes.
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 | PDF4me Support |
| URL | https://dev.pdf4me.com/help/ |
| support@pdf4me.com |
| Connector Metadata | |
|---|---|
| Publisher | Ynoox GmbH |
| Website | https://dev.pdf4me.com/ |
| Privacy policy | https://dev.pdf4me.com/privacy-policy/ |
| Categories | AI;Website |
PDF4me Connect lets you automate a lot of PDF related tasks. You can integrate PDF4me connector with Flow in easy steps. To know about the integration & more, visit our documentation page: PDF4me : Getting Started
To use this integration, you need to have an account on the PDF4me Developer Portal. Follow steps below to get your Subscription Key.
How to get PDF4me Subscription Key
- Register in PDF4me Developer Portal and start a Free Trial
- Go to Api Keys tab in the Developer Portal.
- Select an application or Create a new application.
- You will find a Primary Key and Secondary Key listed under the application. Click on Copy Key button beside the Primary Key for Power Automate text and paste it to Power Automate PDF4me connection
You're now ready to start using this integration.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
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 |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
Add Attachment To Pdf
Attach files as attachment to the PDF file. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/add-attachment-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
|
Attachment File Content
|
docContent | string |
The content of the attachment file |
|
|
Attachment File Name
|
Name | True | string |
Name of the attachment file |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Add Barcode to PDF
Add a barcode or QR code to your PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/add-barcode-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
Map PDF File Content for adding Barcode. |
|
PDF File Name
|
docName | True | string |
PDF file name with file extension |
|
Text
|
text | True | string |
Text to be embedded as barcode. |
|
Barcode Type
|
barcodeType | True | string |
Type of barcode to be added |
|
Pages
|
pages | True | string |
Mention the page numbers for adding barcode like 1,2 |
|
Horizontal Alignment
|
alignX | True | string |
Select the Horizontal alignment |
|
Vertical Alignment
|
alignY | True | string |
Select the Vertical alignment |
|
Height
|
heightInMM | True | string |
Height of the barcode in Millimeter. 0 for auto. |
|
Width
|
widthInMM | True | string |
Width of the barcode in Millimeter. 0 for auto. |
|
Margin Horizontal
|
marginXInMM | True | string |
Margin from vertical edge to the barcode in Millimeter |
|
Margin Vertical
|
marginYInMM | True | string |
Margin from horizontal edge to the barcode in Millimeter |
|
Opacity
|
opacity | True | integer |
Give number between 0 to 100. 0 is completely transparent. 100 for completely opaque. |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Add HTML Header Footer to PDF
Add HTML content as header or footer or both to PDF file. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/add-html-header-footer-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
|
HTML Content
|
htmlContent | True | string |
HTML Content to be added to header/footer |
|
Location
|
location | string |
Location of Html Content |
|
|
Pages
|
pages | True | string |
Pages where content should be added |
|
Skip First Page
|
skipFirstPage | boolean |
Skip First Page |
|
|
Margin Left (px)
|
marginLeft | string |
Margin to be added on the left side (px) |
|
|
Margin Right (px)
|
marginRight | string |
Margin to be added on the right side (px) |
|
|
Margin Top (px)
|
marginTop | string |
Margin to be added on the top (px) |
|
|
Margin Bottom (px)
|
marginBottom | string |
Margin to be added at the bottom (px) |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Add Image Stamp to PDF
Add Image Watermark or Stamp to the PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/image-stamp/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
Map PDF File Content for adding Image Watermark |
|
PDF File Name
|
docName | True | string |
PDF file name with file extension |
|
Image File Content
|
imageFile | True | byte |
Map Image File Content from the source action |
|
Image File Name
|
imageName | True | string |
Image file name with file extension |
|
Pages
|
pages | True | string |
Specify the page numbers for adding stamp like 1,2, or all. Default-all. |
|
Horizontal Alignment
|
alignX | True | string |
Select the Horizontal Alignment |
|
Vertical Alignment
|
alignY | True | string |
Select the Vertical Alignment |
|
Height
|
heightInMM | True | string |
Height of the image in Millimeter. '0' for auto. |
|
Width
|
widthInMM | True | string |
Width of the image in Millimeter. '0' for auto. |
|
Margin Horizontal
|
marginXInMM | True | string |
Margin from Left origin of the image in Millimeter |
|
Margin Vertical
|
marginYInMM | True | string |
Margin from Top origin of the image in Millimeter |
|
Transparency
|
opacity | True | integer |
Specify a value between 0 to 100. 0 is completely transparent, 100 for fully opaque. |
|
Print Only
|
showOnlyInPrint | boolean |
Show watermark only when printing |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Add Margin to PDF
Add Margins to the PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/add-margin/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source PDF file content from the previous action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Margin Left (mm)
|
marginLeft | True | string |
Margin to be added on the left side of the page (mm) |
|
Margin Right (mm)
|
marginRight | True | string |
Margin to be added on the right side of the page (mm) |
|
Margin Top (mm)
|
marginTop | True | string |
Margin to be added on the top of the page (mm) |
|
Margin Bottom (mm)
|
marginBottom | True | string |
Margin to be added at the bottom of the page (mm) |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Add Page Number to PDF
Add Page Numbers to PDF Pages. https://dev.pdf4me.com/power-automate/documentation/actions/add-page-number-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
Map source File Content from the source action |
|
PDF File Name
|
docName | True | string |
Source file name with file extension |
|
Page Format
|
pageNumberFormat | string |
Page number format to be displayed |
|
|
Horizontal Alignment
|
alignX | True | string |
Select the Horizontal Alignment |
|
Vertical Alignment
|
alignY | True | string |
Select the Vertical Alignment |
|
Horizontal Margin
|
marginXinMM | integer |
Horizontal Margin in Millimeter |
|
|
Vertical Margin
|
marginYinMM | integer |
Vertical Margin in Millimeter |
|
|
Font Size
|
fontSize | True | integer |
Font Size for the page numbering |
|
Set Bold
|
isBold | boolean |
Set Bold font for page numbers |
|
|
Set Italic
|
isItalic | boolean |
Set Italic font for page numbers |
|
|
Skip First Page
|
skipFirstPage | boolean |
Skip numbering in the first page of the document |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Add Text Stamp to PDF
Add a background Text Watermark to PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/text-stamp/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content for adding the Watermark |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Text
|
text | True | string |
Text to be added as Watermark |
|
Font Size
|
fontSize | integer |
Set text font size |
|
|
Font Color
|
fontColor | string |
Set font color |
|
|
Set watermark text to Bold
|
isBold | boolean | ||
|
Set watermark text to Italics
|
isItalics | boolean | ||
|
Underline watermark text
|
underline | boolean | ||
|
Pages
|
pages | True | string |
Specify the page numbers to add watermark like 1,2, or all. Default - all |
|
Horizontal Alignment
|
alignX | True | string |
Select the Horizontal alignment |
|
Vertical Alignment
|
alignY | True | string |
Select the Vertical alignment |
|
Horizontal Margin
|
marginXInMM | string |
Margin from Left or Right origin of the image in Millimeter |
|
|
Vertical Margin
|
marginYInMM | string |
Margin from Top or Bottom origin of the image in Millimeter |
|
|
Transparency
|
opacity | string |
Specify a value between 0 to 100. 0 is completely transparent, 100 for fully opaque. |
|
|
Rotate
|
rotate | integer |
Rotate angle in degree (0 to 360) |
|
|
Print Only
|
showOnlyInPrint | boolean |
Show watermark only when printing |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Call Custom API
Call Custom API from PDF. https://dev.pdf4me.com/power-automate/documentation/actions/custom-api-call/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Feature path
|
featurePath | True | string |
Method Name or ID of the feature to be called |
|
body
|
body | string |
Returns
Classify Document
Classify or Identify documents based on the file content. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/classify-document/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | string |
Name of the file |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Class Name
|
className | string |
Class names of the document |
Compress PDF
Optimize or Compress a PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/compress-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Optimize Profile
|
optimizeProfile | True | string |
Choose the compression profile |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Convert HTML to PDF
Convert HTML pages to PDF. https://dev.pdf4me.com/power-automate/documentation/actions/html-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action. HTML/ZIP supported. |
|
HTML File Name
|
docName | True | string |
HTML file name with extension |
|
Index File Path
|
indexFilePath | string |
Index File Path required if input file is ZIP. |
|
|
Page Layout
|
layout | string |
Set page layout. |
|
|
Page Size
|
format | string |
Set Paper size |
|
|
Scale
|
scale | float |
Scale to page. |
|
|
Top Margin
|
topMargin | string |
Set top margin. |
|
|
Bottom Margin
|
bottomMargin | string |
Set bottom margin. |
|
|
Left Margin
|
leftMargin | string |
Set left margin. |
|
|
Right Margin
|
rightMargin | string |
Set right margin. |
|
|
Print Background
|
printBackground | boolean |
Display background images. |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Convert Md to PDF
Convert MD files to PDF. https://dev.pdf4me.com/power-automate/documentation/actions/markdown-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action. .md/.zip supported. |
|
Input File Name
|
docName | True | string |
Source file name with file extension |
|
Markdown File Path
|
mdFilePath | string |
Markdown File Path required if input file is ZIP. |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Convert PDF to editable PDF using OCR
Recognize text and create searchable PDF using OCR. https://dev.pdf4me.com/power-automate/documentation/actions/pdf-ocr/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
QualityType
|
qualityType | True | string |
Choose QualityType |
|
OCR Only When Needed
|
ocrWhenNeeded | string |
Do OCR Only When Needed |
|
|
Language
|
language | string |
Language of the source file |
|
|
Is Async
|
isAsync | boolean |
Set process as Async if takes long time |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Convert PDF to Excel
Convert PDFs with tabular data into Excel spreadsheets. https://dev.pdf4me.com/power-automate/documentation/actions/pdf-to-excel/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
QualityType
|
qualityType | True | string |
Choose QualityType |
|
Language
|
language | string |
Language of the source file |
|
|
Merge All Sheets
|
mergeAllSheets | boolean |
Merge All Sheets after conversion to excel |
|
|
Output Format
|
outputFormat | string |
Choose Output Format |
|
|
Is Async
|
isAsync | boolean |
Set process as Async if takes long time |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Convert PDF to PowerPoint
Convert PDF into Powerpoint Presentation slides. https://dev.pdf4me.com/power-automate/documentation/actions/pdf-to-powerpoint/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
QualityType
|
qualityType | string |
Choose Quality Type |
|
|
Language
|
language | string |
Language of the source file |
|
|
Is Async
|
isAsync | boolean |
Set process as Async if takes long time |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Convert PDF to Word
Convert PDF documents to high quality editable Word files. https://dev.pdf4me.com/power-automate/documentation/actions/pdf-to-word/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
QualityType
|
qualityType | True | string |
Choose QualityType |
|
Language
|
language | string |
Language of the source file |
|
|
Is Async
|
isAsync | boolean |
Set process as Async if takes long time |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Convert to PDF
Convert any type of office documents or images into PDFs. https://dev.pdf4me.com/power-automate/documentation/actions/convert-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Convert URL to PDF
Convert your URL file to PDF. https://dev.pdf4me.com/power-automate/documentation/actions/url-to-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Web URL
|
webUrl | True | string |
Web URL to be converted as PDF |
|
Auth Type
|
authType | string |
Authentication Type for Url Website if any |
|
|
Username
|
username | string |
Username if auth is required |
|
|
Password
|
password | string |
Password if auth is required |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Convert Word to PDF Form
Convert a Word file to PDF with form controls intact. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/convert-word-to-pdf-form/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the Word file |
|
File Name
|
Name | True | string |
Name of the Word file |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Create a Thumbnail Image [DEPRECATED]
Create thumbnail for the PDF document. https://pdf4me.com/power-automate/documentation/actions/create-thumbnail/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Input file content from the source |
|
File Name
|
name | True | string |
Input file name from the source |
|
Image Extension
|
ImageExtension | True | string |
Choose the image extension from the list |
|
PageNrs
|
PageNrs | True | array of integer |
PageNrs |
|
Width Pixels
|
WidthPixel | True | integer |
Size of the thumbnail image in (Width)Pixels |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Create Barcode
Create Barcode or QR code image from text. https://dev.pdf4me.com/power-automate/documentation/actions/create-barcode/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Barcode Type
|
barcodeType | True | string |
Set Barcode Type |
|
Text
|
text | True | string |
Text to be embedded as Barcode |
|
Hide Text
|
hideText | boolean |
Hide text in the barcode image |
Returns
Output file content from the PDF4me Connect.
- Barcode Image
- binary
Create Images from PDF
Convert PDF pages into Images. https://dev.pdf4me.com/power-automate/documentation/actions/create-thumbnail/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
name | True | string |
Source file name with file extension |
|
Image Extension
|
ImageExtension | True | string |
Choose the Image format from the list |
|
PageNrs
|
PageNrs | True | array of integer |
PageNrs |
|
Width Pixels
|
WidthPixel | True | integer |
Size(Width) of the image to be generated in Pixels |
|
Page Numbers
|
pageNrs | True | string |
Page Numbers of the PDF to be converted to Image |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Create PdfA
Create PDFA compliant document. https://dev.pdf4me.com/power-automate/documentation/actions/create-pdfa/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Compliance
|
compliance | True | string |
Select the compliance from the list |
|
Allow Upgrade
|
allowUpgrade | boolean |
Allow upgrade of compliance |
|
|
Allow Downgrade
|
allowDowngrade | boolean |
Allow downgrade of compliance |
Returns
Output File Content from the PDF4me API response
- File Content
- binary
Delete Blank Pages from PDF
Delete blank pages from the PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/delete-blank-pages/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source PDF file content from the previous action |
|
File Name
|
Name | True | string |
Source file name with proper file extension |
|
Delete Option
|
deletePageOption | True | string |
Choose Delete Option |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Delete Pages from PDF
Delete unwanted pages from the PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/delete-pages/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source PDF file content from the previous action |
|
File Name
|
Name | True | string |
Source file name with proper file extension |
|
Page Numbers
|
pageNumbers | True | string |
Specify Pages to be deleted (e.g: 1,2) |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Digital Sign PDF
Add digital sign to the PDF document. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/digital-sign-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
PDF file content |
|
PDF File Name
|
Name | True | string |
Name of the PDF file |
|
Certificate File
|
signCertificate | True | byte |
Certificate file content |
|
Certificate Password
|
signCertificatePassword | True | string |
Password for the certificate file |
|
Page Number
|
pageNr | string |
Page number in the file |
|
|
Margin X
|
marginX | integer |
Position from bottom of page |
|
|
Margin Y
|
marginY | integer |
Position from left of page |
|
|
Width
|
width | integer |
Width of certificate |
|
|
Height
|
height | integer |
Height of certificate |
|
|
Sign Location
|
sigLocation | string |
Certificate Sign Location |
|
|
Signer Name
|
signerName | string |
Signer's Name. |
|
|
Sign Reason
|
sigReason | string |
Reason for signing |
|
|
Visible
|
visible | boolean |
Certificate should be visible or not |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Extract Attachment from PDF
Extract attachments from the PDF file. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/extract-attachment-from-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Extract Form Data from PDF
Extract form data from the PDF. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/extract-form-data-from-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
traceId
|
traceId | string |
Trace Id |
Extract Pages from PDF
Extract required pages from a PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/extract-pages/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Page Numbers
|
pageNumbers | True | string |
Specify Page Numbers to be extracted (e.g: 1,2) |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Extract Text and Images from PDF
Extract text and images from the PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/extract-resources/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Input file content from the source |
|
File Name
|
Name | True | string |
Input file name from the source |
|
Extract Text
|
extractText | boolean |
Extract text true/false |
|
|
Extract Images
|
extractImages | boolean |
Extract images true/false |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
texts
|
texts | array of string |
texts |
|
images
|
images | array of object |
Images |
|
File Name
|
images.fileName | string |
Output file name |
|
File Content
|
images.streamFile | byte |
Output file content |
Extract Text by Expression
Extracts text from PDF using regular expression. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/extract-text-by-expression/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
|
Expression
|
expression | True | string |
Regular expression to extract text |
|
Pages
|
pageSequence | True | string |
Pages where content should be added |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
textList
|
textList | array of string |
Text List |
Fill a PDF Form
Generate Document From PDF Template. https://pdf4me.com/power-automate/documentation/actions/fill-a-pdf-form/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
PDF Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Form Data
|
dataArray | True | string |
Data Collection as list of object. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Find and Replace Text
Find and replace text in PDF. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/find-and-replace-text/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
|
Old Text
|
oldText | True | string |
Text to be searched |
|
New Text
|
newText | True | string |
Text to be replaced with |
|
Pages
|
pageSequence | True | string |
Pages where text should be replaced |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Flatten Pdf
Use Flatten to remove all form controls from the PDF file. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/flatten-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Generate Document (Single)
Generate Documents from DOCX, PDF or HTML template. https://dev.pdf4me.com/power-automate/documentation/actions/generate-document/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Type
|
templateFileType | True | string |
Choose the Template File Type |
|
Template File Name
|
templateFileName | True | string |
Template file name with file extension. |
|
Template File Data
|
templateFileData | True | byte |
Map source template file content from the previous action. |
|
Document Data Type
|
documentDataType | True | string |
Choose Document Data Type |
|
Document Data File
|
documentDataFile | byte |
Map source Data file content from the previous action. |
|
|
Document Data Text
|
documentDataText | string |
Required only if 'Document Data File' is not mapped |
|
|
Field Metadata
|
metaDataJson | string |
Metadata for fields in JSON format |
|
|
Output Type
|
outputType | True | string |
Choose Output Document Type |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Generate Document From HTML [DEPRECATED]
Generate Document From HTML Template. https://pdf4me.com/power-automate/documentation/actions/generate-document-from-html/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
HTML Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Data string
|
dataArray | True | string |
Data Collection as list of object. |
|
Output Type
|
outputType | string |
Choose Output Type |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Generate Document From Word [DEPRECATED]
Generate Document From Word Template. https://pdf4me.com/power-automate/documentation/actions/generate-document-from-word/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
Word Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Input Data Type
|
inputDataType | string |
Choose Input Data Type |
|
|
Data string
|
dataArray | True | string |
Data Collection as list of object. |
|
Field Metadata
|
metaDataJson | string |
Metadata for fields in Json format |
|
|
Output Type
|
outputType | string |
Choose Output Document Type |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Generate Documents (Multiple)
Generate Document from Docx/Pdf/Html. https://dev.pdf4me.com/power-automate/documentation/actions/generate-documents/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Type
|
templateFileType | True | string |
Choose Template File Type |
|
Template File Name
|
templateFileName | True | string |
Template file name with proper file extension. |
|
Template File Data
|
templateFileData | True | byte |
Map source template file content from the previous action. |
|
Document Data Type
|
documentDataType | True | string |
Choose Document Data Type |
|
Document Data File
|
documentDataFile | byte |
Map source document file content from the previous action. |
|
|
Document Data Text
|
documentDataText | string |
Required only if 'Document Data File' is not mapped |
|
|
Field Metadata
|
metaDataJson | string |
Metadata for fields in Json format |
|
|
Output Type
|
outputType | True | string |
Choose Output Document Type |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Get Pdf Metadata
Get PDF Metadata. https://dev.pdf4me.com/power-automate/documentation/actions/pdf-metadata/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source PDF file content from the previous action |
|
File Name
|
Name | True | string |
Source file name with file extension |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
Title | string |
Page Title |
|
Subject
|
Subject | string |
Page Subject |
|
PageCount
|
PageCount | string |
Count |
|
Author
|
Author | string |
Author |
|
Size
|
Size | string |
Size |
|
Creator
|
Creator | string |
Creator |
|
Producer
|
Producer | string |
Produced By |
|
CreationDate
|
CreationDate | string |
CreationDate |
|
ModDate
|
ModDate | string |
Modified Date |
|
IsEncrypted
|
IsEncrypted | boolean |
Is Encrypted |
|
IsLinearized
|
IsLinearized | boolean |
Fast Web View |
|
PdfCompliance
|
PdfCompliance | string |
PDF Compliance Level |
|
IsSigned
|
IsSigned | boolean |
Is Signed |
|
PdfVersion
|
PdfVersion | string |
PDF Version |
Linearize PDF
Linearize PDF. Modify the file for easy web viewing. https://dev.pdf4me.com/power-automate/documentation/actions/linearize-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Compress Type
|
optimizeProfile | True | string |
Choose the compression type |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Mail Merge with Data File (List of Docs) [DEPRECATED]
Merge document template with data from excel or Json file. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-file-list/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Data File Content
|
dataDocContent | True | byte |
Data file content. Supported only .xlsx and .json types. |
|
Data File Name
|
dataDocName | True | string |
Data Collection file name. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Mail Merge with Data File (Single Doc) [DEPRECATED]
Merge document template with data from excel or Json file. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-file-single/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Data File Content
|
dataDocContent | True | byte |
Data file content. Supported only .xlsx and .json types. |
|
Data File Name
|
dataDocName | True | string |
Data Collection file name. |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Mail Merge with Data String (List of Docs)
Merge document template with data as JSON string. https://dev.pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-string-list/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
Map the Template File Content from source |
|
Template File Name
|
templateDocName | True | string |
Template file name with file extension |
|
Data string
|
dataArray | True | string |
Data Collection as list of array. e.g [[""V1","V2","V3","V4"],["V1","V2","V3","V4"]]" |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
outputDocuments
|
outputDocuments | array of object |
Output Documents |
|
File Name
|
outputDocuments.fileName | string |
Output file name |
|
File Content
|
outputDocuments.streamFile | byte |
Output file content |
Mail Merge with Data String (Single Doc) [DEPRECATED]
Merge document template with data as json text. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-string-single/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Data string
|
dataArray | True | string |
Data Collection as list of array. ex: ["V1","V2","V3","V4"] |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Merge multiple PDF files into a single PDF file
Merge multiple PDF documents into a single PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/merge/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
docContent
|
docContent | True | array of byte |
docContent |
|
Output File Name
|
Name | True | string |
Name |
Returns
Output file content from PDF4me merge
- File Content
- binary
Merge two PDF files one over another as Overlay
Merge two PDF documents one over another as Overlay. https://dev.pdf4me.com/power-automate/documentation/actions/merge-overlay/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Base File content
|
baseDocContent | True | byte |
Map the Base PDF File Content |
|
Base File Name
|
baseDocName | True | string |
Base PDF File Name with extension |
|
Layer File Content
|
layerDocContent | True | byte |
Map Top Layer PDF File Content |
|
Layer File Name
|
layerDocName | True | string |
Top layer PDF file name with extension |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Parse Document
Parse or read content from PDF based on preconfigured templates. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/parse-document/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | byte |
The content of the input file |
|
|
File Name
|
Name | string |
Name of the file |
|
|
Template Name
|
TemplateName | string |
Name of the template for parsing |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
traceId
|
traceId | string |
traceId |
Produce document with dynamic data collection and templates [DEPRECATED]
Produce your document with dynamic data collection and templates.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template File Data
|
templateDocContent | True | byte |
Template file content. |
|
Template File Name
|
templateDocName | True | string |
Template file name. |
|
Data File Content
|
dataDocContent | byte |
DataCollection file content. |
|
|
Data File Name
|
dataDocName | string |
Data Collection file name. |
|
|
OutputType
|
outputType | True | string |
Choose OutputType |
Returns
Output file content from the PDF4me Connect.
- File Content
- binary
Protect Document
Protect PDF document with custom password. https://dev.pdf4me.com/power-automate/documentation/actions/protect-document/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Password
|
password | True | string |
Custom password |
|
PDF Permission
|
pdfPermission | True | string |
Allowed permission for the document |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Read Barcode from PDF
Reads and extracts barcode or QR code data from PDF. https://dev.pdf4me.com/power-automate/documentation/actions/read-barcode-from-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map the File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
barcodeType
|
barcodeType | True | array of string |
barcodeType |
|
Pages
|
pages | string |
Mention the page numbers like 1,2 or all |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
barcodes
|
barcodes | array of object |
barcodes |
|
Barcode Type
|
barcodes.barcodeType | string |
Output Barcode Type |
|
Barcode Text
|
barcodes.Value | string |
Output Barcode Text |
|
Barcode Page Number
|
barcodes.page | integer |
Output barcode page number |
Repair PDF Document
Recover broken PDFs partially or fully. https://dev.pdf4me.com/power-automate/documentation/actions/repair-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source PDF file content from the previous action |
|
File Name
|
Name | True | string |
Source file name with file extension |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Replace Text with Image
Replace text in the PDF file with an image. Please refer here for more info - https://dev.pdf4me.com/power-automate/documentation/actions/replace-text-with-image/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
The content of the input file |
|
File Name
|
Name | True | string |
Name of the file |
|
Replace Text
|
replaceText | True | string |
Text to be replaced |
|
Image
|
imageContent | byte |
Replacement Image |
|
|
Image Height
|
imageHeight | string |
Height of the image. 0 for auto detect. |
|
|
Image Width
|
imageWidth | string |
Width of the image. 0 for auto detect. |
|
|
Pages
|
pageSequence | True | string |
Pages where content should be added |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Rotate Document
Rotate all the pages of a PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/rotate/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Rotation Type
|
rotationType | True | string |
Select the rotation type from the list |
Returns
Output file content from the PDF4me API response
- File Content
- binary
Rotate Page
Rotate a specific page of a PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/rotate-page/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
Map source File Content from the source action |
|
PDF File Name
|
docName | True | string |
Source file name with file extension |
|
Page Number
|
page | True | integer |
Specify the Page number from the PDF |
|
Rotation Type
|
rotationType | True | string |
Select the rotation type from the list |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Send Document to PDF4me-Workflow
Start PDF4me Workflow with document from anywhere https://dev.pdf4me.com/power-automate/documentation/actions/send-document-to-pdf4me-workflow/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action. |
|
Input File Name
|
docName | True | string |
File name with file extension |
|
PDF4me-Workflow Name
|
wfName | True | string |
Set your PDF4me-Workflow name |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Status
|
status | string |
PDF4me WorkFlow trigger status |
|
Job Id
|
jobId | string |
JobId of the executed PDF4me Workflow |
Sign PDF
Place a Sign to the PDF document. https://dev.pdf4me.com/power-automate/documentation/actions/sign-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
Map PDF File Content from the source action |
|
PDF File Name
|
docName | True | string |
PDF file name with file extension |
|
Sign File Content
|
imageFile | True | byte |
Map Signature Image file content from source |
|
Sign Image File Name
|
imageName | True | string |
Signature Image file name with extension |
|
Align Horizontal
|
alignX | True | string |
Select the Horizontal Alignment |
|
Align Vertical
|
alignY | True | string |
Select the Vertical Alignment |
|
Pages
|
pages | True | string |
Specify the page numbers for adding sign. e.g 1,2 |
|
Height
|
heightInMM | string |
Height of the Sign in Millimeter. '0' for auto. |
|
|
Width
|
widthInMM | string |
Width of the image in Millimeter. '0' for auto. |
|
|
Margin Horizontal
|
marginXInMM | True | string |
Margin from Left origin of the image in Millimeter |
|
Margin Vertical
|
marginYInMM | True | string |
Margin from Top origin of the image in Millimeter |
|
Opacity
|
opacity | True | integer |
Give number between 0 to 100. 0 is completely transparent. 100 for fully opaque. |
Returns
Output file content from the PDF4me Connect
- File Content
- binary
Split Document
Split PDF by page number or recurring pages. https://dev.pdf4me.com/power-automate/documentation/actions/split-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Split Action
|
splitAction | True | string |
Choose the split action type |
|
Split Page Number
|
splitActionNumber | True | integer |
Enter the value based on the split action |
|
Split File Naming
|
fileNaming | string |
Split File Naming |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
splitedDocuments
|
splitedDocuments | array of object |
Splited Documents |
|
File Name
|
splitedDocuments.fileName | string |
Output file name |
|
File Content
|
splitedDocuments.streamFile | byte |
Output file content |
Split Document by Barcode
Split PDF documents using barcode contained in them. https://dev.pdf4me.com/power-automate/documentation/actions/split-by-barcode/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Barcode Filter
|
barcodeFilter | True | string |
Choose the Barcode filter |
|
Barcode Data
|
barcodeString | True | string |
Type the barcode data to split |
|
Barcode Type
|
barcodeType | True | string |
Choose the Barcode type |
|
Split Barcode Page
|
splitBarcodePage | True | string |
Choose the Split Barcode Page |
|
Combine Pages
|
combinePagesWithSameConsecutiveBarcodes | boolean |
Combine pages with same barcodes. Any pages having consecutively same barcode texts will be merged as a single document |
|
|
PDF Render DPI
|
pdfRenderDpi | string |
Pdf Render Dpi for barcode. Accepted values - 100, 150, 200, 250 |
|
|
Is Async
|
isAsync | boolean |
Set process as Async if takes long time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
splitedDocuments
|
splitedDocuments | array of object |
Splited Documents |
|
File Name
|
splitedDocuments.fileName | string |
Output file name |
|
Barcode Text
|
splitedDocuments.barcodeText | string |
Output barcode text |
|
File Content
|
splitedDocuments.streamFile | byte |
Output file content |
Split PDF by Text
Split PDF by recognizing specific text in them. https://dev.pdf4me.com/power-automate/documentation/actions/split-pdf-by-text/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
docContent | True | byte |
Map source File Content from the source action |
|
File Name
|
Name | True | string |
Source file name with file extension |
|
Text
|
text | True | string |
Search Text |
|
Split Type
|
splitTextPage | True | string |
Choose how to Split |
|
Split File Naming
|
fileNaming | string |
Split File Naming |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
splitedDocuments
|
splitedDocuments | array of object |
Splited Documents |
|
File Name
|
splitedDocuments.fileName | string |
Output file name |
|
Text
|
splitedDocuments.docText | string |
Text read from file |
|
File Content
|
splitedDocuments.streamFile | byte |
Output file content |
Unlock PDF
Removes password protection from a PDF file. https://dev.pdf4me.com/power-automate/documentation/actions/unlock-pdf/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF File content
|
docContent | True | byte |
Map source File Content from the source action |
|
PDF File Name
|
docName | True | string |
Source file name with file extension |
|
Password
|
password | True | string |
Password set for the PDF file. |
Returns
Output file content from the PDF4me API response.
- File Content
- binary
Triggers
| Get Document from PDF4me |
Triggers when a document is sent from PDF4me apps. |
Get Document from PDF4me
Triggers when a document is sent from PDF4me apps.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
Name | True | string |
Name of the PDF4me action |
Definitions
binary
This is the basic data type 'binary'.