Muhimbi PDF

  • Reference

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
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Muhimbi Support
URL https://support.muhimbi.com
Email support@muhimbi.com
Connector Metadata
Publisher Muhimbi Ltd
Website http://www.muhimbi-online.com/
Privacy policy https://support.muhimbi.com/hc/en-us/articles/228090747-Muhimbi-Ltd-Privacy-Policy
Categories Collaboration;Content and Files

The Muhimbi PDF Converter Online is the market leading solution to Convert, Merge, Watermark, Secure and OCR files using Power Automate, SharePoint Online and your own custom code.

It supports a large number of file formats including MS-Word, Excel, InfoPath, PowerPoint, MSG, EML, Visio, Images, HTML and AutoCAD.

It fits in any business process, but common uses are archiving content in PDF(A) format, sharing files in a universally recognised file format, preparing content for display on mobile devices and generating meeting packs.

Various tutorials and videos can be found here.

Prerequisites

In order to use this connector you require either a free or paid account for Muhimbi PDF Online.

How to get credentials

Create an account the first time the connector is used, or pre-generate an account here.

Please familiarise yourself with the differences between the 'Free' and 'Trial' accounts.

Known issues and limitations

Please note that source documents secured via IRM /RDM / RMS /AIP based solutions cannot be processed due to security restrictions.

If you have any questions, or would like to setup a screen share, please contact our friendly Support Desk.

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 CAD drawing to PDF

Convert a CAD drawing file to PDF or other format.
Convert document

Convert a file to PDF or other format.
Convert document to PDF-A

Convert a document to PDF-A.
Convert email to PDF

Convert an email file to PDF or other format.
Convert Excel document

Convert an Excel document to PDF or other format.
Convert HTML to PDF

Convert URLs or HTML to PDF.
Convert InfoPath document

Convert a InfoPath file to PDF or other format.
Convert PowerPoint document

Convert a PowerPoint document to PDF or other format.
Convert to OCRed PDF

Convert a file to an OCRed PDF.
Convert Visio document

Convert a Visio document to PDF or XPS.
Convert Word document

Convert a Word document to PDF or other format.
Copy metadata (SharePoint only)

Copy metadata and set content type.
Export PDF Forms Data

Convert data from a PDF Form to XML, FDF or XFDF.
Extract text using OCR

Extract text from a file using OCR.
Import PDF Forms data

Import PDF Forms data.
Merge documents

Merge multiple files into a single PDF.
Secure document

Apply security and encryption settings.
Split PDF

Split a PDF file into multiple PDFs.

Add composite watermark

Operation ID:
composite_watermark

Add a complex watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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

Body
operation_response

Add ellipse watermark

Operation ID:
ellipse_watermark

Add an ellipse watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add image watermark

Operation ID:
image_watermark

Add an image based watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add line watermark

Operation ID:
line_watermark

Add a line watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add Linear Barcode watermark

Operation ID:
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

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add PDF watermark

Operation ID:
pdf_watermark

Add a PDF based watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add QR Code watermark

Operation ID:
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

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add rectangle watermark

Operation ID:
rectangle_watermark

Add a rectangle watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add RTF watermark

Operation ID:
rtf_watermark

Add a rich-text watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Add text watermark

Operation ID:
text_watermark

Add a plain-text watermark to a PDF file.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
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
 x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)
Y Coordinate
 y string

Y Coordinate when 'Position' is set to 'Absolute' (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
Watermark start section
 start_section integer

The first section in a Word or Excel document the watermark is visible
Watermark end section
 end_section integer

The last section in a Word or Excel document the watermark is visible
Watermark page type
 page_type string

One or more page types for Word and Excel documents, eg. default|first|even
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Convert CAD drawing to PDF

Operation ID:
convert_cad

Convert a CAD drawing 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
Paper size
 paper_size enum

Paper size for the output
Paper size (custom)
 paper_size_custom string

Applicable if 'Paper size' is set to 'Custom'
Page margins
 page_margins string

E.g. '1.5cm' (for uniform) or '0.5in, 0.25in, 0.5in, 0.25in' (for non-uniform) margins
Background color
 background_color string

.Net color name or hex color (#aarrggbb or #rrggbb)
Foreground color
 foreground_color enum

The foreground effect or color
Foreground color (custom)
 foreground_color_custom string

.Net color name or hex color (#aarrggbb or #rrggbb). Applicable if 'Foreground color' is set to 'Custom'
Empty layout detection
 empty_layout_detection_mode enum

Select which layouts should be skipped
Layout Sort Order
 layout_sort_order enum

Specify the sort order in which the layouts are converted
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
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

Body
operation_response

Convert document

Operation ID:
convert

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

Body
operation_response

Convert document to PDF-A

Operation ID:
convert_pdfa

Convert a document to PDF-A.

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
PDF profile
 pdf_profile True enum

PDF profile to use for rendering the document
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

Body
operation_response

Convert email to PDF

Operation ID:
convert_email

Convert an email 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
Include attachments
 convert_attachments boolean

Include attachments
Attachment action
 attachment_merge_mode enum

What to do with attachments
Attachment summary
 display_attachment_summary boolean

Display attachment name in the email header
Unsupported attachment action
 unsupported_attachment_behaviour enum

What to do with attachments which cannot be converted into PDF
Include attachment filter
 include_attachment_types string

Comma separated values, e.g. *.txt, June???.docx
Exclude attachment filter
 exclude_attachment_types string

Comma separated values, e.g. *.txt, June???.docx
Viewport size
 viewport_Size string

Specify the viewport size for the conversion in pixels. E.g. 1024x768
Paper size
 paper_size enum

Paper size for the output
Paper size (custom)
 paper_size_custom string

Applicable if 'Paper size' is set to 'Custom'
Page margins
 page_margins string

E.g. '1.5cm' (for uniform) or '0.5in,0.25in,0.5in,0.25in' (for non-uniform) margins.
Attachment errors
 break_merge_on_error boolean

How to deal with failure when converting attachments
Min. image size
 minimum_image_attachment_dimension integer

Exclude images smaller than the specified number of pixels
Offline mode
 enable_offline_mode boolean

In offline mode external resources are disabled
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
Conversion quality
 quality enum

Quality of the output file
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

Body
operation_response

Convert Excel document

Operation ID:
convert_excel

Convert an Excel document 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
Range
 range enum

Specify which parts of the document to process
Reveal hidden rows
 unhide_all_rows boolean

Specify whether you would like hidden rows to be revealed
Reveal hidden columns
 unhide_all_columns boolean

Specify whether you would like hidden columns to be revealed
Fit to # pages wide
 fit_to_pages_wide integer

Fit all columns onto this number of pages
Fit to # Pages tall
 fit_to_pages_tall integer

Fit all rows onto this number of pages
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
Quality
 quality enum

Quality of the output file
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

Body
operation_response

Convert HTML to PDF

Operation ID:
convert_html

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

Body
operation_response

Convert InfoPath document

Operation ID:
convert_infopath

Convert a InfoPath 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
Template file content
 template_file_content byte

Optional XSN file content
View names
 views_to_convert string

Comma separated list view names to convert
Include attachment
 convert_attachments boolean

Include attachments
Attachment action
 attachment_merge_mode enum

What to do with attachments
Unsupported attachment action
 unsupported_attachment_behaviour enum

What to do with attachments which cannot be converted into PDF
Break merge on error
 break_merge_on_error boolean

Break conversion when processing of an individual part fails
Include attachment filter
 include_attachment_types string

Comma separated values, e.g. *.txt, June???.docx
Exclude attachment filter
 exclude_attachment_types string

Comma separated values, e.g. *.txt, June???.docx
Default paper size
 default_paper_size enum

Specify paper size to be used when it is not specified in the view
Default paper size (custom)
 default_paper_size_custom string

Applicable if 'Default paper size' is set to 'Custom'
Force paper size
 force_paper_size enum

Force this papers size regardless of whether it is set in the views or not
Force paper size (custom)
 force_paper_size_custom string

Applicable if 'Force paper size' is set to custom
Default page orientation
 default_page_orientation enum

Specify papers size to be used if it is not specified in the view
Force page orientation
 force_page_orientation enum

Force page orientation regardless of whether it is set in the view or not
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
Conversion quality
 quality enum

Quality of the output file
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

Body
operation_response

Convert PowerPoint document

Operation ID:
convert_powerpoint

Convert a PowerPoint document 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
Range
 range enum

Specify which parts of the document to process
Print layout / handouts
 print_output_type enum

Specify how you would like the output to be arranged
Frame slides
 frame_slides boolean

Include a frame / border around the slides
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
Quality
 quality enum

Quality of the output file
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

Body
operation_response

Convert to OCRed PDF

Operation ID:
ocr_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

Body
operation_response

Convert Visio document

Operation ID:
convert_visio

Convert a Visio document to PDF or XPS.

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
Range
 range enum

Specify which parts of the file to render
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
Quality
 quality enum

Quality of the output file
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

Body
operation_response

Convert Word document

Operation ID:
convert_word

Convert a Word document 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
Display for review
 revisions_and_comments_display_mode enum

Choose what changes would you like to see in this document
Review markup mode
 revisions_and_comments_markup_mode enum

Choose how you would like to see changes in this document
Generate bookmarks
 generate_bookmarks enum

Choose weather you would like to generate bookmarks based on the document structure
Start page
 start_page integer

The first page to include
End page
 end_page integer

The last page to include
Quality
 quality enum

Quality of the output file
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

Body
operation_response

Copy metadata (SharePoint only)

Operation ID:
copy_metadata

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

Body
operation_response_common

Export PDF Forms Data

Operation ID:
export_form_data

Convert data from a PDF Form to XML, FDF or XFDF.

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 data format
 output_format True enum

Output data format
Fail on error
 fail_on_error boolean

Fail on error

Returns

Response data for all operations

Body
operation_response

Extract text using OCR

Operation ID:
ocr_text

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

Body
ocr_operation_response

Import PDF Forms data

Operation ID:
import_form_data

Import PDF Forms data.

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
PDF Form file content
 pdf_template_file_content byte

Content of the PDF Form file
PDF Form URL
 pdf_template_url string

URL of the PDF Form
Username
 pdf_template_username string

Username to access PDF Form URL
Domain
 pdf_template_domain string

Domain for Username to access PDF Form URL
Password
 pdf_template_password string

Password to access PDF Form URL
Flatten
 flatten enum

Flatten the result
Read-only
 read_only enum

Make the result read-only
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

Body
operation_response

Merge documents

Operation ID:
merge_to_pdf

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

Body
operation_response

Secure document

Operation ID:
secure_pdf

Apply security and encryption settings.

Parameters

Name Key Required Type Description
Source file name
 source_file_name string

Name of the source file including extension
Source file content
 source_file_content True byte

Content of the file to secure
Open password
 open_password password

Password required to open the document
Owner password
 owner_password password

Password required to edit the document (and for PDF apply 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

Body
operation_response

Split PDF

Operation ID:
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

Body
split_operation_response

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.