Share via

Cloudmersive File Processing (Preview)

  • Reference

File Processing lets you effortlessly create, process, convert and update 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
Name Cloumdersive Support
URL https://account.cloudmersive.com/contact-support
Email support@cloudmersive.com
Connector Metadata
Publisher Cloudmersive, LLC
Website https://www.cloudmersive.com/nlp-api
Privacy policy https://www.cloudmersive.com/privacy-policy
Categories AI;Content and Files

This connector is critical for processing files, archives and text. Cloudmersive File Processing covers a wide array of common file processing needs, including compressing, encrypting or extracting zips, processing files, and text. Stateless high-security processing ensures fast performance and strong security. You can learn more at the File Processing API page.

To use the File Processing 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 File Processing Connector.

Now you are ready to start using the Cloudmersive File Processing 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
API Key (from https://cloudmersive.com) securestring The Api Key for this API True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Base 64 decode, convert base 64 string to binary content

Decodes / converts base 64 UTF-8 text string to binary content
Base 64 encode, convert binary or file data to a text string

Encodes / converts binary or file data to a text string
Compress files and folders to create a new zip archive with advanced options

Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.
Compress files to create a new zip archive

Create a new zip archive by compressing input files.
Create a web-based viewer

Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
Decrypt and remove password protection on a zip file

Decrypts and removes password protection from an encrypted zip file with the specified password
Detect, check if text string is base 64 encoded

Checks, detects if input string is base 64 encoded
Detect line endings of a text file

Detect line ending type (Windows, Unix or Mac) of an input file.
Detect text encoding of file

Checks text encoding of file
Encrypt and password protect a zip file

Encrypts and password protects an existing zip file with the specified password and encryption algorithm
Extract, decompress files and folders from a zip archive

Extracts a zip archive by decompressing files, and folders.
Find a regular expression regex in text input

Find all occurrences of the input regular expression in the input content, and returns the matches
Find a string in text input

Finds all occurrences of the input string in the input content, and returns the matches
Get comments from a Word DOCX document as a flat list

Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
Remove HTML from text string

Removes HTML from text, leaving behind only text. Formatted text will become plain text. Important for protecting against HTML and Cross-Site-Scripting attacks.
Remove whitespace from text string

Removes all whitespace from text, leaving behind only non-whitespace characters. Whitespace includes newlines, spaces and other whitespace characters.
Replace a string in text with a regex regular expression string

Replaces all occurrences of the input regular expression regex string in the input content, and returns the result
Replace a string in text with another string value

Replaces all occurrences of the input string in the input content, and returns the result
Set, change line endings of a text file

Sets the line ending type of a text file; set to Windows, Unix or Mac.
Trim leading and trailing whitespace from text string

Trim leading and trailing whitespace from text, leaving behind a trimmed string. Whitespace includes newlines, spaces and other whitespace characters.
Validate if a file is executable

Validate if an input file is a valid binary executable file.

Base 64 decode, convert base 64 string to binary content

Operation ID:
EditText_Base64Decode

Decodes / converts base 64 UTF-8 text string to binary content

Parameters

Name Key Required Type Description
Base64ContentToDecode
 Base64ContentToDecode string

Input content to decode from Base 64 into binary

Returns

Result of base 64 decoding

Body
Base64DecodeResponse

Base 64 encode, convert binary or file data to a text string

Operation ID:
EditText_Base64Encode

Encodes / converts binary or file data to a text string

Parameters

Name Key Required Type Description
ContentToEncode
 ContentToEncode byte

Input content to encode into Base 64

Returns

Result of base 64 encoding

Body
Base64EncodeResponse

Compress files and folders to create a new zip archive with advanced options

Operation ID:
ZipArchive_ZipCreateAdvanced

Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.

Parameters

Name Key Required Type Description
FileName
 FileName string

Name of this file
FileContents
 FileContents byte

Contents of this file
DirectoryName
 DirectoryName string

Name of this directory
FileName
 FileName string

Name of this file
FileContents
 FileContents byte

Contents of this file

Returns

response
object

Compress files to create a new zip archive

Operation ID:
ZipArchive_ZipCreate

Create a new zip archive by compressing input files.

Parameters

Name Key Required Type Description
First input file to perform the operation on.
 inputFile1 True file

First input file to perform the operation on.
Second input file to perform the operation on.
 inputFile2 file

Second input file to perform the operation on.
Third input file to perform the operation on.
 inputFile3 file

Third input file to perform the operation on.
Fourth input file to perform the operation on.
 inputFile4 file

Fourth input file to perform the operation on.
Fifth input file to perform the operation on.
 inputFile5 file

Fifth input file to perform the operation on.
Sixth input file to perform the operation on.
 inputFile6 file

Sixth input file to perform the operation on.
Seventh input file to perform the operation on.
 inputFile7 file

Seventh input file to perform the operation on.
Eighth input file to perform the operation on.
 inputFile8 file

Eighth input file to perform the operation on.
Ninth input file to perform the operation on.
 inputFile9 file

Ninth input file to perform the operation on.
Tenth input file to perform the operation on.
 inputFile10 file

Tenth input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Create a web-based viewer

Operation ID:
ViewerTools_CreateSimple

Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.

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 creating a viewer

Body
ViewerResponse

Decrypt and remove password protection on a zip file

Operation ID:
ZipArchive_ZipDecrypt

Decrypts and removes password protection from an encrypted zip file with the specified password

Parameters

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

Input file to perform the operation on.
Required; Password for the input archive
 zipPassword True string

Required; Password for the input archive

Returns

response
object

Detect, check if text string is base 64 encoded

Operation ID:
EditText_Base64Detect

Checks, detects if input string is base 64 encoded

Parameters

Name Key Required Type Description
Base64ContentToDetect
 Base64ContentToDetect string

Input content text to detect if it is base 64 encoded

Returns

Result of base 64 detection

Body
Base64DetectResponse

Detect line endings of a text file

Operation ID:
EditText_DetectLineEndings

Detect line ending type (Windows, Unix or Mac) of an input file.

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 base 64 decoding

Body
DetectLineEndingsResponse

Detect text encoding of file

Operation ID:
EditText_TextEncodingDetect

Checks text encoding of file

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 detecting text encoding

Body
TextEncodingDetectResponse

Encrypt and password protect a zip file

Operation ID:
ZipArchive_ZipEncryptAdvanced

Encrypts and password protects an existing zip file with the specified password and encryption algorithm

Parameters

Name Key Required Type Description
InputFileContents
 InputFileContents byte

Input Zip File archive contents in bytes
Password
 Password string

Password to place on the Zip file; the longer the password, the more secure
EncryptionAlgorithm
 EncryptionAlgorithm string

Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.

Returns

response
object

Extract, decompress files and folders from a zip archive

Operation ID:
ZipArchive_ZipExtract

Extracts a zip archive by decompressing files, and folders.

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 performing a zip extract operation

Body
ZipExtractResponse

Find a regular expression regex in text input

Operation ID:
EditText_FindRegex

Find all occurrences of the input regular expression in the input content, and returns the matches

Parameters

Name Key Required Type Description
TextContent
 TextContent string

Input text content
TargetRegex
 TargetRegex string

Target input regular expression (regex) to find
MatchCase
 MatchCase boolean

Set to True to match case, False to ignore case

Returns

Result of finding a string

Body
FindStringRegexResponse

Find a string in text input

Operation ID:
EditText_FindSimple

Finds all occurrences of the input string in the input content, and returns the matches

Parameters

Name Key Required Type Description
TextContent
 TextContent string

Input text content
TargetString
 TargetString string

Target input string to find

Returns

Result of finding a string

Body
FindStringSimpleResponse

Get comments from a Word DOCX document as a flat list

Operation ID:
EditDocument_DocxGetComments

Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).

Parameters

Name Key Required Type Description
InputFileBytes
 InputFileBytes byte

Optional: Bytes of the input file to operate on
InputFileUrl
 InputFileUrl string

Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

Returns

Result of getting comments from a Word Document DOCX

Body
GetDocxCommentsResponse

Remove HTML from text string

Operation ID:
EditText_RemoveHtml

Removes HTML from text, leaving behind only text. Formatted text will become plain text. Important for protecting against HTML and Cross-Site-Scripting attacks.

Parameters

Name Key Required Type Description
TextContainingHtml
 TextContainingHtml string

Input text string to remove the HTML from

Returns

Result of removing HTML from a string

Body
RemoveHtmlFromTextResponse

Remove whitespace from text string

Operation ID:
EditText_RemoveAllWhitespace

Removes all whitespace from text, leaving behind only non-whitespace characters. Whitespace includes newlines, spaces and other whitespace characters.

Parameters

Name Key Required Type Description
TextContainingWhitespace
 TextContainingWhitespace string

Input text string to remove the whitespace from

Returns

Result of removing whitespace from a string

Body
RemoveWhitespaceFromTextResponse

Replace a string in text with a regex regular expression string

Operation ID:
EditText_ReplaceRegex

Replaces all occurrences of the input regular expression regex string in the input content, and returns the result

Parameters

Name Key Required Type Description
TextContent
 TextContent string

Input text content
RegularExpressionString
 RegularExpressionString string

Target input regular expression (regex) string to match and be replaced; supports all regular expression values
ReplaceWithString
 ReplaceWithString string

Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on

Returns

Result of replacing a regex string

Body
ReplaceStringRegexResponse

Replace a string in text with another string value

Operation ID:
EditText_ReplaceSimple

Replaces all occurrences of the input string in the input content, and returns the result

Parameters

Name Key Required Type Description
TextContent
 TextContent string

Input text content
TargetString
 TargetString string

Target input string to match and be replaced
ReplaceWithString
 ReplaceWithString string

Replacement for target string

Returns

Result of replacing a string

Body
ReplaceStringSimpleResponse

Set, change line endings of a text file

Operation ID:
EditText_ChangeLineEndings

Sets the line ending type of a text file; set to Windows, Unix or Mac.

Parameters

Name Key Required Type Description
Line ending type
 lineEndingType True string

'Windows' will use carriage return and line feed, 'Unix' will use newline, and 'Mac' will use carriage return.
Input file to perform the operation on.
 inputFile True file

Input file to perform the operation on.

Returns

Result of performing a change line ending operation

Body
ChangeLineEndingResponse

Trim leading and trailing whitespace from text string

Operation ID:
EditText_TrimWhitespace

Trim leading and trailing whitespace from text, leaving behind a trimmed string. Whitespace includes newlines, spaces and other whitespace characters.

Parameters

Name Key Required Type Description
TextContainingWhitespace
 TextContainingWhitespace string

Input text string to remove the whitespace from

Returns

Result of removing whitespace from a string

Body
RemoveWhitespaceFromTextResponse

Validate if a file is executable

Operation ID:
ValidateDocument_ExecutableValidation

Validate if an input file is a valid binary executable file.

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Body
DocumentValidationResult

Definitions

GetDocxCommentsResponse

Result of getting comments from a Word Document DOCX

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
Comments
 Comments array of DocxComment

Comments in the document
CommentCount
 CommentCount integer

The number of comments in the document

DocxComment

Comment in a Word Document

Name Path Type Description
Path
 Path string

Path to the comment in the document
Author
 Author string

Author name of the comment
AuthorInitials
 AuthorInitials string

Initials of the author of the comment
CommentText
 CommentText string

Text content of the comment
CommentDate
 CommentDate date-time

Date timestamp of the comment
IsTopLevel
 IsTopLevel boolean

True if the comment is at the top level, false if this comment is a child reply of another comment
IsReply
 IsReply boolean

True if this comment is a reply to another comment, false otherwise
ParentCommentPath
 ParentCommentPath string

Path to the parent of this comment, if this comment is a reply, otherwise this value will be null
Done
 Done boolean

True if this comment is marked as Done in Word, otherwise it is false

Base64DetectResponse

Result of base 64 detection

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
IsBase64Encoded
 IsBase64Encoded boolean

True if the input string is base 64 encoded, false otherwise

Base64EncodeResponse

Result of base 64 encoding

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
Base64TextContentResult
 Base64TextContentResult string

Result of performing a base 64 encoding operation, a text string representing the encoded original file content

Base64DecodeResponse

Result of base 64 decoding

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
ContentResult
 ContentResult byte

Result of performing a base 64 decode operation, binary file content

TextEncodingDetectResponse

Result of detecting text encoding

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
TextEncoding
 TextEncoding string

Text encoding used in file; possible values are ASCII, UTF7, UTF8, UTF16, BigEndianUnicode and UTF32

FindStringSimpleResponse

Result of finding a string

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
Matches
 Matches array of FindStringMatch

Found matches
MatchCount
 MatchCount integer

The number of matches

FindStringMatch

Individual match result of finding a target string in a longer text string

Name Path Type Description
CharacterOffsetStart
 CharacterOffsetStart integer

0-based index of the start of the match
CharacterOffsetEnd
 CharacterOffsetEnd integer

0-based index of the end of the match
ContainingLine
 ContainingLine string

Text content of the line containing the match

FindStringRegexResponse

Result of finding a string

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
Matches
 Matches array of FindRegexMatch

Regular expression matches
MatchCount
 MatchCount integer

The number of matches

FindRegexMatch

Individual regular expression match result of finding a target regex in a longer text string

Name Path Type Description
CharacterOffsetStart
 CharacterOffsetStart integer

0-based index of the start of the match
CharacterOffsetEnd
 CharacterOffsetEnd integer

0-based index of the end of the match
ContainingLine
 ContainingLine string

Text content of the line containing the match
MatchValue
 MatchValue string

The match value
MatchGroups
 MatchGroups array of string

Regular expression regex match groups; these correspond to the match values

ReplaceStringSimpleResponse

Result of replacing a string

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
TextContentResult
 TextContentResult string

Result of performing a replace string operation

ReplaceStringRegexResponse

Result of replacing a regex string

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
TextContentResult
 TextContentResult string

Result of performing a base 64 decode operation, binary file content

DetectLineEndingsResponse

Result of base 64 decoding

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
PrimaryNewlineType
 PrimaryNewlineType string

Type of newline in the file; possible vlaues are "Mac" (legacy Mac OS uses carriage return only); "Unix" (Unix and Linux OSes, and modern Mac OS); "Windows" (Windows operating systems)
PrimaryNewlineTerminator
 PrimaryNewlineTerminator string

Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed
InputLength
 InputLength integer

Length of the input string in characters

ChangeLineEndingResponse

Result of performing a change line ending operation

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
TextContentResult
 TextContentResult string

Text content result

RemoveHtmlFromTextResponse

Result of removing HTML from a string

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
TextContentResult
 TextContentResult string

Result of performing a remove HTML from string operation

RemoveWhitespaceFromTextResponse

Result of removing whitespace from a string

Name Path Type Description
Successful
 Successful boolean

True if successful, false otherwise
TextContentResult
 TextContentResult string

Result of performing a remove whitespace from string operation

DocumentValidationError

Validation error found in document

Name Path Type Description
Description
 Description string

Description of the error
Path
 Path string

XPath to the error
Uri
 Uri string

URI of the part in question
IsError
 IsError boolean

True if this is an error, false otherwise

DocumentValidationResult

Document validation result

Name Path Type Description
DocumentIsValid
 DocumentIsValid boolean

True if the document is valid and has no errors, false otherwise
PasswordProtected
 PasswordProtected boolean

True if the document is password protected, false otherwise
ErrorCount
 ErrorCount integer

Number of validation errors found in the document
WarningCount
 WarningCount integer

Number of validation warnings found in the document
ErrorsAndWarnings
 ErrorsAndWarnings array of DocumentValidationError

Details of errors and warnings found

ViewerResponse

Result of creating a viewer

Name Path Type Description
HtmlEmbed
 HtmlEmbed string
Successful
 Successful boolean

ZipFile

Representation of a file in a zip file

Name Path Type Description
FileName
 FileName string

Name of this file
FileContents
 FileContents byte

Contents of this file

ZipDirectory

Representation of a directory in a zip file

Name Path Type Description
DirectoryName
 DirectoryName string

Name of this directory
DirectoriesInDirectory
 DirectoriesInDirectory array of ZipDirectory

Child directories contained directly in this directory
FilesInDirectory
 FilesInDirectory array of ZipFile

Child files contained directly in this directory

ZipExtractResponse

Result of performing a zip extract operation

Name Path Type Description
Successful
 Successful boolean

True if the operation was successful, false otherwise
FilesInZip
 FilesInZip array of ZipFile

Top-level files in the root directory fo the zip file
DirectoriesInZip
 DirectoriesInZip array of ZipDirectory

Top-level directories in the root directory of the zip; directories can contain sub-directories and files

object

This is the type 'object'.

binary

This is the basic data type 'binary'.