Muhimbi PDF

Convert, Merge, Watermark, Secure and OCR 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 China regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add composite watermark

Add a complex watermark to a PDF file.

Add ellipse watermark

Add an ellipse watermark to a PDF file.

Add image watermark

Add an image based watermark to a PDF file.

Add line watermark

Add a line watermark to a PDF file.

Add Linear Barcode watermark

Add a Linear Barcode watermark to a PDF file.

Add PDF watermark

Add a PDF based watermark to a PDF file.

Add QR Code watermark

Add a QR Code watermark to a PDF file.

Add rectangle watermark

Add a rectangle watermark to a PDF file.

Add RTF watermark

Add a rich-text watermark to a PDF file.

Add text watermark

Add a plain-text watermark to a PDF file.

Convert document

Convert a file to PDF or other format.

Convert HTML to PDF

Convert URLs or HTML to PDF.

Convert to OCRed PDF

Convert a file to an OCRed PDF.

Copy metadata (SharePoint only)

Copy metadata and set content type.

Extract text using OCR

Extract text from a file using OCR.

Merge documents

Merge multiple files into a single PDF.

Secure PDF

Apply security and encryption settings.

Split PDF

Split a PDF file into multiple PDFs.

Add composite watermark

Add a complex watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Watermark data
watermark_data True string

Watermark data in Muhimbi XML format

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add ellipse watermark

Add an ellipse watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Fill color
fill_color string

Color in #RRGGBB notation

Line color
line_color string

Color in #RRGGBB notation

Line width
line_width string

Width of the line (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add image watermark

Add an image based watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Image
image_file True byte

Image content or URL

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark outline color
line_color string

Color in #RRGGBB notation

Watermark outline width
line_width string

Width of the watermark outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add line watermark

Add a line watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Position
position True enum

Watermark position on the page

X Coordinate (start)
x True string

Start X Coordinate of the line (in Pts, 1/72 of an inch)

Y Coordinate (start)
y True string

Start Y Coordinate of the line (in Pts, 1/72 of an inch)

X Coordinate (end)
end_x True string

End X Coordinate of the line (in Pts, 1/72 of an inch)

Y Coordinate (end)
end_y True string

End Y Coordinate of the line (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Line color
line_color string

Color in #RRGGBB notation

Line width
line_width string

Width of the line (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add Linear Barcode watermark

Add a Linear Barcode watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Barcode content
content True string

Data to embed in the Linear Barcode

Barcode type
barcode_type True enum

The type of the barcode

Omit encoding of start/stop symbols
omit_start_stop_symbols enum

Flag indicating if start and stop symbols have to be encoded into the barcode or not

Disable check digit
disable_checkdigit True enum

Flag indicating if the check digit has to be calculated or not

Show check digit
show_checkdigit True enum

Flag indicating if the check digit should be displayed in the barcode label or not

Margin
margin string

Margin around the barcode

Font family
font_family_name string

Name of the font, e.g. Arial, Times New Roman, Calibri

Font size
font_size string

Size of the font in Pt

Font style
font_style string

One or more styles, e.g. bold|italic|underline|strikeout

Label placement
label_placement enum

Placement of the barcode label

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Barcode background color
fill_color string

Color in #RRGGBB notation

Barcode bar color
line_color string

Color in #RRGGBB notation

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add PDF watermark

Add a PDF based watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

PDF Watermark
pdf_file True byte

PDF watermark content or URL

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add QR Code watermark

Add a QR Code watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Content
content True string

Data to embed in the QR Code

Version
version True enum

Version

Input mode
input_mode True enum

Input mode

Error correction level
error_correction_level True enum

Error correction level

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark foreground color
line_color string

Color in #RRGGBB notation

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add rectangle watermark

Add a rectangle watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark outline color
line_color string

Color in #RRGGBB notation

Watermark outline width
line_width string

Width of the watermark outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add RTF watermark

Add a rich-text watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Watermark content
rtf_data True string

Watermark text in RTF format

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark outline color
line_color string

Color in #RRGGBB notation

Watermark outline width
line_width string

Width of the watermark outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add text watermark

Add a plain-text watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to watermark

Watermark content
content True string

Watermark text

Font family name
font_family_name True string

Name of the font, e.g. Arial, Times New Roman, Calibri

Font size
font_size True string

Size of the font in Pt

Font color
fill_color True string

Color in #RRGGBB notation

Text alignment
alignment True enum

Text alignment

Word wrap
word_wrap True enum

Spcifies if wordwrap text

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate (When 'Position' is set to 'Absolute')
x string

X Coordinate of the watermark (in Pts, 1/72 of an inch)

Y Coordinate (When 'Position' is set to 'Absolute')
y string

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Font style
font_style string

One or more styles, e.g. bold|italic|underline|strikeout

Font outline color
line_color string

Color in #RRGGBB notation

Font outline width
line_width string

Width of the font outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Convert document

Convert a file to PDF or other format.

Parameters

Name Key Required Type Description
Source file name
source_file_name True string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to convert

Output format
output_format True enum

Output format

Override settings
override_settings string

Optional settings using Muhimbi's XML syntax

Template file content
template_file_content byte

Optional template file content (e.g. infopath XSN file)

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Convert HTML to PDF

Convert URLs or HTML to PDF.

Parameters

Name Key Required Type Description
Source URL or HTML
source_url_or_html True string

HTML fragment or URL to convert

Page orientation
page_orientation enum

Page orientation

Media type
media_type enum

Media type

Authentication type
authentication_type enum

Authentication type

User name
username string

User name

Password
password password

Password

Viewport size
viewport_size string

Optional width and height of the simulated browser (e.g. 1024x768)

Conversion delay
conversion_delay integer

Conversion delay (in milliseconds)

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Convert to OCRed PDF

Convert a file to an OCRed PDF.

Parameters

Name Key Required Type Description
Source file name
source_file_name True string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to OCR

Language
language enum

Language

Performance
performance enum

Performance

Blacklist / whitelist
characters_option enum

Characters option

Characters
characters string

Characters to blacklist or whitelist

Use pagination
paginate boolean

Paginate

Regions
regions string

Limit the area to OCR to one or more specific areas

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Copy metadata (SharePoint only)

Copy metadata and set content type.

Parameters

Name Key Required Type Description
Site url
site_url True string

SharePoint site url (example: http://contoso.sharepoint.com/sites/mysite)

Source file url
source_file_url True string

Path to the source file

Destination file path
destination_file_url True string

Path to the destination file

User name
username string

User name to log in to the SharePoint site

Password
password string

Password to log in to the SharePoint site

Fields to copy
copy_fields string

Optional comma separated list of fields

Destination content type
content_type string

Optional content type for the destination file

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Extract text using OCR

Extract text from a file using OCR.

Parameters

Name Key Required Type Description
Source file name
source_file_name True string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to OCR

Language
language enum

Language

X Coordinate
x string

X Coordinate (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate (in Pts, 1/72 of an inch)

Width
width string

Width of the OCR area (in Pts, 1/72 of an inch)

Height
height string

Height of the OCR area (in Pts, 1/72 of an inch)

Page number
page_number string

Page number (leave blank to OCR all pages)

Performance
performance enum

Performance ()

Blacklist / whitelist
characters_option enum

Characters option

Characters
characters string

Characters to blacklist or whitelist

Use pagination
paginate boolean

Paginate

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for OCRText operation

Merge documents

Merge multiple files into a single PDF.

Parameters

Name Key Required Type Description
Source file name - 1
source_file_name_1 string

Name of the source file including extension

Source file content - 1
source_file_content_1 byte

Content of the file to merge

Source file name - 2
source_file_name_2 string

Name of the source file including extension

Source file content - 2
source_file_content_2 byte

Content of the file to merge

Source file name - 3
source_file_name_3 string

Name of the source file including extension

Source file content - 3
source_file_content_3 byte

Content of the file to merge

Source file name - 4
source_file_name_4 string

Name of the source file including extension

Source file content - 4
source_file_content_4 byte

Content of the file to merge

Source file name - 5
source_file_name_5 string

Name of the source file including extension

Source file content - 5
source_file_content_5 byte

Content of the file to merge

Each document
document_start_page enum

Document start page

name
source_file_name True string

Name of the source file including extension

content
source_file_content True byte

Content of the file to merge

Override settings
override_settings string

Optional settings using Muhimbi's XML syntax

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Secure PDF

Apply security and encryption settings.

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Optional file name (for logging purposes)

Source file content
source_file_content True byte

Content of the file to secure

Open password
open_password password

Password required to open the PDF

Owner password
owner_password password

Password for PDF restrictions defined below

PDF restrictions
security_options string

Print|HighResolutionPrint|ContentCopy|Annotations|FormFields|ContentAccessibility|DocumentAssembly

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Split PDF

Split a PDF file into multiple PDFs.

Parameters

Name Key Required Type Description
Source file name
source_file_name True string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to split

File name template
file_name_template string

File name template for returned files

Split by
file_split_by True enum

Split by option

Split parameter
split_parameter True integer

Split parameter (number of pages or level)

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for split operation

Definitions

ocr_operation_response

Response data for OCRText operation

Name Path Type Description
Out text
out_text string

Extracted OCRed text in plain text.

Base file name
base_file_name string

Name of the input file without the extension.

Result code
result_code enum

Operation result code.

Result details
result_details string

Operation result details.

operation_response

Response data for all operations

Name Path Type Description
Processed file content
processed_file_content byte

File generated by the Muhimbi converter.

Base file name
base_file_name string

Name of the input file without the extension.

Result code
result_code enum

Operation result code.

Result details
result_details string

Operation result details.

operation_response_common

Response data for all operations

Name Path Type Description
Base file name
base_file_name string

Name of the input file without the extension.

Result code
result_code enum

Operation result code.

Result details
result_details string

Operation result details.

processed_files

Individual files

Name Path Type Description
Processed file name
processed_file_name string

Name of the file with the extension.

Processed file content
processed_file_content byte

File generated by the Muhimbi converter.

split_operation_response

Response data for split operation

Name Path Type Description
Processed files
processed_files array of processed_files

Files generated by the Muhimbi converter.

Result code
result_code enum

Operation result code.

Result details
result_details string

Operation result details.