Share via


Cloudmersive PDF

PDF lets you effortlessly create, convert, process, edit, work with, encrypt, and sign PDF files.

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
URL https://account.cloudmersive.com/contact-support
Connector Metadata
Publisher Cloudmersive, LLC
Website https://cloudmersive.com/pdf-api
Privacy policy https://cloudmersive.com/privacy-policy

This connector is critical for any application that works with PDF to generate PDFs, enhance PDFs, encrypt and password protect PDFs, add watermarks, convert between formats, and extract information from PDFs. Stateless high-security processing ensures fast performance and strong security. Cloudmersive PDF covers a wide array of key PDF processing and PDF security capabilities. You can learn more at the PDF API page.

To use this connector, you need a Cloudmersive account. You can sign up with a Microsoft Account or create a Cloudmersive account. Follow the steps below to get your API Key.

Get the API Key and Secret

  • Register for a Cloudmersive Account
  • Sign In with your Cloudmersive Account and click on API Keys

Here you can create and see your API key(s) listed on the API Keys page. Simply copy and paste this API Key into the Cloudmersive PDF Connector.

Now you are ready to start using the Cloudmersive PDF Connector.

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
KEY securestring The KEY for this API True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a text watermark to a PDF

Adds a text watermark to a PDF

Add one or more PDF annotations, comments in the PDF document

Adds one or more annotations, comments to a PDF document.

Decrypt and password-protect a PDF

Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.

Encrypt, password-protect and set restricted permissions on a PDF

Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).

Encrypt and password-protect a PDF

Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

Get PDF annotations, including comments in the document

Enumerates the annotations, including comments and notes, in a PDF document.

Get PDF document metadata

Returns the metadata from the PDF document, including Title, Author, etc.

Get text in a PDF document by page

Gets the text in a PDF by page

Gets PDF Form fields and values

Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

Insert, copy pages from one PDF document into another

Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).

Rasterize a PDF to an image-based PDF

Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.

Remove, delete pages from a PDF document

Remove one or more pages from a PDF document

Remove a specific PDF annotation, comment in the document

Removes a specific annotation in a PDF document, using the AnnotationIndex. To enumerate AnnotationIndex for all of the annotations in the PDF document, use the /edit/pdf/annotations/list API.

Remove all PDF annotations, including comments in the document

Removes all of the annotations, including comments and notes, in a PDF document.

Rotate a range, subset of pages in a PDF document

Rotate a range of specific pages in a PDF document by a multiple of 90 degrees

Rotate all pages in a PDF document

Rotate all of the pages in a PDF document by a multiple of 90 degrees

Sets ands fills PDF Form field values

Fill in the form fields in a PDF form with specific values. Use form/get-fields to enumerate the available fields and their data types in an input form.

Sets PDF document metadata

Sets (writes) metadata into the input PDF document, including Title, Author, etc.

Add a text watermark to a PDF

Adds a text watermark to a PDF

Parameters

Name Key Required Type Description
Watermark text to add to the PDF (required)
watermarkText True string

Watermark text to add to the PDF (required)

Font Family Name for the watermark text; default is Times New Roman
fontName string

Font Family Name for the watermark text; default is Times New Roman

Font Size in points of the text; default is 150
fontSize number

Font Size in points of the text; default is 150

Font color in hexadecimal or HTML color name; default is Red
fontColor string

Font color in hexadecimal or HTML color name; default is Red

Font transparency between 0.0 (completely transparent) to 1.0 (fully o
fontTransparency number

Font transparency between 0.0 (completely transparent) to 1.0 (fully o

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Add one or more PDF annotations, comments in the PDF document

Adds one or more annotations, comments to a PDF document.

Parameters

Name Key Required Type Description
AnnotationIndex
AnnotationIndex integer

The 0-based index of the annotation in the document

AnnotationType
AnnotationType string

Type of the annotation; possible values are Text

CreationDate
CreationDate date-time

Date that the annotation was created

Height
Height double

Height of the annotation

LeftX
LeftX double

Left X coordinate for the location of the annotation

ModifiedDate
ModifiedDate date-time

Date that the annotation was last modified

PageNumber
PageNumber integer

The 1-based index of the page containing the annotation

Subject
Subject string

Subject of the annotation

TextContents
TextContents string

Text contents of the annotation

Title
Title string

Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files

TopY
TopY double

Top Y coordination of the location of the annotation

Width
Width double

Width of the annotation

InputFileBytes
InputFileBytes byte

Input file contents bytes for the file to modify

Returns

Output file content from the operation

OutputContent
binary

Decrypt and password-protect a PDF

Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.

Parameters

Name Key Required Type Description
Valid password for the PDF file
password True string

Valid password for the PDF file

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Encrypt, password-protect and set restricted permissions on a PDF

Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).

Parameters

Name Key Required Type Description
Password of a owner (creator/editor) of the PDF file (required)
ownerPassword True string

Password of a owner (creator/editor) of the PDF file (required)

Password of a user (reader) of the PDF file (optional)
userPassword True string

Password of a user (reader) of the PDF file (optional)

Possible values are "128" (128-bit RC4 encryption) and "256" (256-bit
encryptionKeyLength string

Possible values are "128" (128-bit RC4 encryption) and "256" (256-bit

Set to false to disable printing through DRM. Default is true.
allowPrinting boolean

Set to false to disable printing through DRM. Default is true.

Set to false to disable document assembly through DRM. Default is true.
allowDocumentAssembly boolean

Set to false to disable document assembly through DRM. Default is true.

Set to false to disable copying/extracting content out of the PDF thro
allowContentExtraction boolean

Set to false to disable copying/extracting content out of the PDF thro

Set to false to disable filling out form fields in the PDF through DRM
allowFormFilling boolean

Set to false to disable filling out form fields in the PDF through DRM

Set to false to disable editing in the PDF through DRM (making the PDF
allowEditing boolean

Set to false to disable editing in the PDF through DRM (making the PDF

Set to false to disable annotations and editing of annotations in the
allowAnnotations boolean

Set to false to disable annotations and editing of annotations in the

Set to false to disable degraded printing of the PDF through DRM. Def
allowDegradedPrinting boolean

Set to false to disable degraded printing of the PDF through DRM. Def

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Encrypt and password-protect a PDF

Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

Parameters

Name Key Required Type Description
Password of a user (reader) of the PDF file
userPassword string

Password of a user (reader) of the PDF file

Password of a owner (creator/editor) of the PDF file
ownerPassword string

Password of a owner (creator/editor) of the PDF file

Possible values are "128" (128-bit RC4 encryption) and "256" (256-bit
encryptionKeyLength string

Possible values are "128" (128-bit RC4 encryption) and "256" (256-bit

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Get PDF annotations, including comments in the document

Enumerates the annotations, including comments and notes, in a PDF document.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Result of retrieving annotations from a PDF document

Get PDF document metadata

Returns the metadata from the PDF document, including Title, Author, etc.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Result of an autodetect/get-info operation

Get text in a PDF document by page

Gets the text in a PDF by page

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Text of the PDF, broken down by page

Gets PDF Form fields and values

Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Result of retrieving PDF form fields

Insert, copy pages from one PDF document into another

Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).

Parameters

Name Key Required Type Description
Source PDF file to copy pages from.
sourceFile True file

Source PDF file to copy pages from.

Destination PDF file to copy pages into.
destinationFile True file

Destination PDF file to copy pages into.

Page number (1 based) to start copying pages from (inclusive) in the S
pageStartSource True integer

Page number (1 based) to start copying pages from (inclusive) in the S

Page number (1 based) to stop copying pages pages from (inclusive) in
pageEndSource True integer

Page number (1 based) to stop copying pages pages from (inclusive) in

Page number (1 based) to insert the pages before in the Destination file.
pageInsertBeforeDesitnation True integer

Page number (1 based) to insert the pages before in the Destination file.

Returns

Output file content from the operation

OutputContent
binary

Rasterize a PDF to an image-based PDF

Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Remove, delete pages from a PDF document

Remove one or more pages from a PDF document

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Page number (1 based) to start deleting pages from (inclusive).
pageStart True integer

Page number (1 based) to start deleting pages from (inclusive).

Page number (1 based) to stop deleting pages from (inclusive).
pageEnd True integer

Page number (1 based) to stop deleting pages from (inclusive).

Returns

Output file content from the operation

OutputContent
binary

Remove a specific PDF annotation, comment in the document

Removes a specific annotation in a PDF document, using the AnnotationIndex. To enumerate AnnotationIndex for all of the annotations in the PDF document, use the /edit/pdf/annotations/list API.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

The 0-based index of the annotation in the document
annotationIndex True integer

The 0-based index of the annotation in the document

Returns

Output file content from the operation

OutputContent
binary

Remove all PDF annotations, including comments in the document

Removes all of the annotations, including comments and notes, in a PDF document.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Rotate a range, subset of pages in a PDF document

Rotate a range of specific pages in a PDF document by a multiple of 90 degrees

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

The angle to rotate the page in degrees, must be a multiple of 90 degr
rotationAngle True integer

The angle to rotate the page in degrees, must be a multiple of 90 degr

Page number (1 based) to start rotating pages from (inclusive).
pageStart True integer

Page number (1 based) to start rotating pages from (inclusive).

Page number (1 based) to stop rotating pages from (inclusive).
pageEnd True integer

Page number (1 based) to stop rotating pages from (inclusive).

Returns

Output file content from the operation

OutputContent
binary

Rotate all pages in a PDF document

Rotate all of the pages in a PDF document by a multiple of 90 degrees

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

The angle to rotate the page in degrees, must be a multiple of 90 degr
rotationAngle True integer

The angle to rotate the page in degrees, must be a multiple of 90 degr

Returns

Output file content from the operation

OutputContent
binary

Sets ands fills PDF Form field values

Fill in the form fields in a PDF form with specific values. Use form/get-fields to enumerate the available fields and their data types in an input form.

Parameters

Name Key Required Type Description
CheckboxValue
CheckboxValue boolean

For fields of type Checkbox, the value to put into the field

ComboBoxSelectedIndex
ComboBoxSelectedIndex integer

For fields of type ComboBox; specifies the selected index of the combo box selection

FieldName
FieldName string

Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form

TextValue
TextValue string

For fields of type Text, the text value to put into the field

InputFileBytes
InputFileBytes byte

Contents of the input file to set the fields on

Returns

Output file content from the operation

OutputContent
binary

Sets PDF document metadata

Sets (writes) metadata into the input PDF document, including Title, Author, etc.

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Input file contents bytes for the file to modify

Author
Author string

User name of the creator/author of the document, if available, null if not available

Creator
Creator string

Creator of the document

DateCreated
DateCreated date-time

The timestamp that the document was created, if available, null if not available

DateModified
DateModified date-time

The timestamp that the document was last modified, if available, null if not available

Keywords
Keywords string

Keywords of the document

PageCount
PageCount integer

The number of pages in the document

Subject
Subject string

Subject of the document

Successful
Successful boolean

True if the operation was successful, false otherwise

Title
Title string

Title of the document

Returns

Output file content from the operation

OutputContent
binary

Definitions

GetPdfAnnotationsResult

Result of retrieving annotations from a PDF document

Name Path Type Description
Annotations
Annotations array of PdfAnnotation

Annotations in the PDF file, ordered by placement from start to finish in the document

Successful
Successful boolean

True if successful, false otherwise

PdfAnnotation

PDF Annotation details

Name Path Type Description
AnnotationIndex
AnnotationIndex integer

The 0-based index of the annotation in the document

AnnotationType
AnnotationType string

Type of the annotation; possible values are Text

CreationDate
CreationDate date-time

Date that the annotation was created

Height
Height double

Height of the annotation

LeftX
LeftX double

Left X coordinate for the location of the annotation

ModifiedDate
ModifiedDate date-time

Date that the annotation was last modified

PageNumber
PageNumber integer

The 1-based index of the page containing the annotation

Subject
Subject string

Subject of the annotation

TextContents
TextContents string

Text contents of the annotation

Title
Title string

Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files

TopY
TopY double

Top Y coordination of the location of the annotation

Width
Width double

Width of the annotation

PdfFormField

Field definition and value in the form

Name Path Type Description
FieldComboBoxSelectedIndex
FieldComboBoxSelectedIndex integer

Applies to ComboBox field types only; specifies the selected index of the combo box selection if available

FieldName
FieldName string

Name of the form field

FieldType
FieldType string

The data type of the field; possible values are Text (FieldValue will be a string), Checkbox (FieldValue can be "true" or "false"), ComboBox (FieldComboBoxSelectedIndex will also be populated), Other

FieldValue
FieldValue string

Value of the form field

PdfFormFields

Result of retrieving PDF form fields

Name Path Type Description
FormFields
FormFields array of PdfFormField

Fields and field values found in the form

Successful
Successful boolean

True if the operation was successful, false otherwise

PdfMetadata

Result of an autodetect/get-info operation

Name Path Type Description
Author
Author string

User name of the creator/author of the document, if available, null if not available

Creator
Creator string

Creator of the document

DateCreated
DateCreated date-time

The timestamp that the document was created, if available, null if not available

DateModified
DateModified date-time

The timestamp that the document was last modified, if available, null if not available

Keywords
Keywords string

Keywords of the document

PageCount
PageCount integer

The number of pages in the document

Subject
Subject string

Subject of the document

Successful
Successful boolean

True if the operation was successful, false otherwise

Title
Title string

Title of the document

PdfPageText

Text of a single page of a PDF

Name Path Type Description
PageNumber
PageNumber integer

Page number of the page (1-based)

PageText
PageText string

Text of the page

PdfTextByPageResult

Text of the PDF, broken down by page

Name Path Type Description
Pages
Pages array of PdfPageText

Pages in the PDF

Successful
Successful boolean

True if the operation was successful, false otherwise

binary

This is the basic data type 'binary'.