Muhimbi PDF

Convert, Compress, Extract Text, Extract Key Value Pairs, 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	https://www.muhimbi.com/
Privacy policy	https://www.muhimbi.com/legal/privacy-policy/
Categories	Collaboration;Content and Files

Easily convert 100+ file types in Power Automate. Automate your document workflows like adding barcodes and watermarks to documents, compressing, OCR, and extracting text from images or merging multiple documents into one. Convert to PDF, Excel, CSV, Word, and Image from different file formats. Convert InfoPath and MS Forms to PDF and MS Office file formats. Turn BI dashboards and reports into PDFs, and create PDFs from Wiki Page, Visio, or CAD files. Fill PDF forms with Power Automate flows and extract PDF form data. Bring Intelligent Document Understanding and Processing features to your unstructured and semi-structured documents with the new key-value pair data extractor. Extract text from PDF files.

Prerequisites

An Office 365 subscription with a SharePoint Online license. Muhimbi PDF Converter for Power Automate full or trial subscription. Note: Free subscription does not support OCR. Appropriate privileges to create Flows.

How to get credentials

To start your free trial, you’ll first need to fill out the registration form. If you need help, check our getting started video. After completing the form, you’ll automatically be redirected to a page where you’ll be able to activate your trial subscription. Once you’ve activated your subscription, refer to the following examples: Power Automate (including Logic Apps, Power Apps, and Azure Functions) Power Automate user guides Video tutorials

Get started with your connector

Muhimbi PDF Converter has almost 30 powerful actions for converting documents and emails, splitting, merging, extracting and more. Here are the common use cases: Convert HTML to PDF - watch the video tutorial or read the user guide Add QR code watermark - watch the video tutorial or read the user guide Extract text using OCR - watch the video tutorial or read the user guide Export PDF forms data- watch the video tutorial or read the user guide Import PDF forms data- watch the video tutorial or read the user guide

Known issues and limitations

Please note that source documents secured via IRM / RDM / RMS / AIP solutions cannot be processed due to security restrictions. If you have any questions, please contact our friendly Support Desk.

Common errors and remedies

https://www.muhimbi.com/guides/pdf-converter/power-automate/troubleshooting/

FAQ

What is the difference between free and trial subscriptions?

In addition to a 30-day fully functional trial version, a completely free version of Muhimbi PDF Converter for SharePoint Online is available as well. The Trial should be used when evaluating the product with the intention to purchase a full subscription. This version provides a large number of operations for 30 days with the ability to use all functionality provided by the product. However, generated documents include an evaluation watermark. The Free version is aimed at users who only need very basic functionality and a modest number of operations per month. Documents generated using the Free subscription DO NOT include an evaluation watermark.

Can I add a new account to an existing subscription?

Yes, it is possible to associate multiple accounts with a single subscription. Muhimbi fully supports this scenario and even allows accounts for Muhimbi PDF Converter REST-API subscriptions (for Flow, Logic Apps, API access) to be associated with an existing Muhimbi PDF Converter for SharePoint Online subscription. That way a single subscription covers our SharePoint Online App, Flow / Logic Apps as well as our REST API.

Can I manually install the Muhimbi PDF integration for Power Automate?

Muhimbi’s PDF Converter is available as a standard Power Automate connector. There is no need to manually follow the installation steps below unless you have been instructed by our support team to do so. To get started with our software, just use Power Automate’s “Add an action” facility, search for ‘Muhimbi’, and choose the action of your choice, e.g. ‘Convert Document’. If you have been asked to manually deploy our API into Power Automate then follow these steps to manually install the Muhimbi PDF Integration for Power Automate. For more frequently asked questions and answers, check our page here.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add composite watermark	Add a complex watermark to a PDF file - https://www.muhimbi.com/guides/pdf-converter/power-automate/apply-multiple-watermarks/
Add ellipse watermark	Add an ellipse watermark to a PDF file.
Add image watermark	Add an image based watermark to a PDF file - https://www.muhimbi.com/guides/pdf-converter/power-automate/add-image-watermark/
Add line watermark	Add a line watermark to a PDF file.
Add Linear Barcode watermark	Add a Linear Barcode watermark to a PDF file - https://www.muhimbi.com/guides/pdf-converter/power-automate/create-barcodes/
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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/create-qr-codes/
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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/watermark/
Compress PDF	Compress a PDF document.
Convert CAD drawing to PDF	Convert a CAD drawing file to a PDF or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/cad-to-pdf/
Convert document	Convert more than 60 file types to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/conversion/
Convert document to PDF-A	Archive documents by converting Office files, images, and PDFs to PDF/A 1b, 2b, and 3b formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/pdf-to-pdfa
Convert email to PDF	Convert an email file to PDF or other format - https://www.muhimbi.com/guides/pdf-converter/power-automate/email-to-pdf/
Convert Excel document	Convert Microsoft Excel (XLS, XLSX, and more) to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/excel-to-pdf
Convert HTML to PDF	Convert URLs or HTML files to PDF - https://www.muhimbi.com/guides/pdf-converter/power-automate/html-to-pdf/
Convert InfoPath document	Convert an InfoPath file to PDF or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/infopath-to-pdf/
Convert PowerPoint document	Convert Microsoft PowerPoint (PPT, PPTX, and more) to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/ppt-to-pdf/
Convert to OCRed PDF	Perform OCR on an existing PDF document or an image to create a searchable PDF - https://www.muhimbi.com/guides/pdf-converter/power-automate/pdf-ocr/
Convert Visio document	Convert a Visio document to PDF or XPS - https://www.muhimbi.com/guides/pdf-converter/power-automate/visio-to-pdf
Convert Word document	Convert Microsoft Word (DOC, DOCX, and more) to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/word-to-pdf/
Copy metadata (SharePoint only)	Copy metadata and set content type - https://www.muhimbi.com/blog/use-microsoft-flow-to-copy-sharepoint-metadata/
Export PDF Forms Data	Convert data from a PDF Form to XML, FDF or XFDF - https://www.muhimbi.com/guides/pdf-converter/power-automate/extract-pdf-form-data/
Extract Key Value Pairs	Extract key value pairs from a PDF document.
Extract Text from PDF	Extract text from a PDF document.
Extract text using OCR	Extract text from a PDF file using OCR - https://www.muhimbi.com/guides/pdf-converter/power-automate/extract-text-from-pdf/
Import PDF Forms data	Import data and fill PDF forms - https://www.muhimbi.com/guides/pdf-converter/power-automate/fill-pdf-form/
Merge documents	Merge multiple file formats into a single PDF document - https://www.muhimbi.com/guides/pdf-converter/power-automate/merge-documents/
Secure document	Encrypt and password-protect a PDF document.
Split PDF	Split a PDF file into multiple PDF documents - https://www.muhimbi.com/guides/pdf-converter/power-automate/split-pdf/

Add composite watermark

Operation ID:

composite_watermark

Add a complex watermark to a PDF file - https://www.muhimbi.com/guides/pdf-converter/power-automate/apply-multiple-watermarks/

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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/add-image-watermark/

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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/create-barcodes/

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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/create-qr-codes/

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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/watermark/

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

Compress PDF

Operation ID:

compress_pdf

Compress a PDF document.

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
Remove Annotations	remove_annotations		enum	Remove the annotations in the PDF
Remove Blank Pages	remove_blank_pages		enum	Remove the blank pages in the PDF
Remove Bookmarks	remove_bookmarks		enum	Remove the bookmarks in the PDF
Remove Embedded Files	remove_embedded_files		enum	Remove the embedded files in the PDF
Remove Form Fields	remove_form_fields		enum	Remove the form fields in the PDF
Remove Hyperlinks	remove_hyperlinks		enum	Remove the hyperlinks in the PDF
Remove JavaScript	remove_javascript		enum	Remove the javascript in the PDF
Remove Metadata	remove_metadata		enum	Remove the metadata in the PDF
Remove Page Thumbnails	remove_page_thumbnails		enum	Remove the page thumbnails in the PDF
Pack Fonts	pack_fonts		enum	Pack the fonts in the PDF
Pack Document	pack_document		enum	Pack the document content in the PDF
Recompress Images	recompress_images		enum	Recompress the images in the PDF
Enable MRC	enable_mrc		enum	Enable MRC compression for the PDF
Downscale Resolution MRC	downscale_resolution_mrc		integer	The downscale resolution value for MRC compression
Preserve Smoothing	preserve_smoothing		enum	Preserve smoothing for the PDF
Image Quality	image_quality		enum	The output image quality for the PDF
Downscale Images	downscale_images		enum	Downscale images during compression for the PDF
Downscale Resolution	downscale_resolution		integer	The downscale resolution value for compression
Enable Color Detection	enable_color_detection		enum	Enable color detection for the PDF
Enable Char Repair	enable_char_repair		enum	Enable character repair for the PDF
Enable JPEG2000	enable_jpeg2000		enum	Enable JPEG2000 compression for the PDF
Enable JBIG2	enable_jbig2		enum	Enable JBIG2 compression for the PDF
JBIG2 PMS Threshold	jbig2_pms_threshold		integer	The threshold for JBIG2 pattern matching and substitution
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 CAD drawing to PDF

Operation ID:

convert_cad

Convert a CAD drawing file to a PDF or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/cad-to-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 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 more than 60 file types to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/conversion/

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

Archive documents by converting Office files, images, and PDFs to PDF/A 1b, 2b, and 3b formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/pdf-to-pdfa

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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/email-to-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 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 Microsoft Excel (XLS, XLSX, and more) to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/excel-to-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 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 files to PDF - https://www.muhimbi.com/guides/pdf-converter/power-automate/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 an InfoPath file to PDF or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/infopath-to-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 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 Microsoft PowerPoint (PPT, PPTX, and more) to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/ppt-to-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 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

Perform OCR on an existing PDF document or an image to create a searchable PDF - https://www.muhimbi.com/guides/pdf-converter/power-automate/pdf-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
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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/visio-to-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 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 Microsoft Word (DOC, DOCX, and more) to PDF documents or other formats - https://www.muhimbi.com/guides/pdf-converter/power-automate/word-to-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 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 - https://www.muhimbi.com/blog/use-microsoft-flow-to-copy-sharepoint-metadata/

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 - https://www.muhimbi.com/guides/pdf-converter/power-automate/extract-pdf-form-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
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 Key Value Pairs

Operation ID:

extract_key_value_pairs

Extract key value pairs from a PDF document.

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
OCR Language	ocr_language		string	The language codes for OCR and KVP extraction, separated by '+'. For example, 'eng+deu+fra' would add English, German, and French.
DPI	dpi		enum	Remove the blank pages in the PDF
KVP Output Format	kvp_format		enum	The output formats separated by commas. KVP data can be output in JSON, CSV and XML. e.g. json,csv,xml
Page Range	page_range		string	The pages to be processed by KVP. Use the string of '1 - 5' for pages 1 to 5, or use the string of '1, 5, 6' to specify pages 1 and 5 and 6.
Autorotate	autorotate		enum	Setting this to 'Yes' will automatically rotate pages if the text does not have the correct orientation.
Trim Symbols	trim_symbols		enum	Setting this to 'Yes' will remove any symbols from the start/end of values, with the exception of the hash '#' or period '.' symbols.
Include Key Bounding Box	include_key_bounding_box		enum	Include the bounding box values for the key in the output
Include Value Bounding Box	include_value_bounding_box		enum	Include the bounding box values for the value in the output
Include Page Number	include_page_number		enum	Include the page number for the key value pair in the output
Include Confidence	include_confidence		enum	Include the confidence score for the key value pair in the output. Confidence is measured between 0 (no confidence) and 100 (full confidence).
Confidence Threshold	confidence_threshold		integer	The confidence threshold a key value pair must reach to be included in the output. Results under the threshold are discarded.
Include Type	include_type		enum	Include the data type for the key value pair in the output
Expected Keys	expected_keys		string	The JSON string containing the expected keys and synonyms
Fail on error	fail_on_error		boolean	Fail on error

Returns

Response data for all operations

Body

operation_response

Extract Text from PDF

Operation ID:

extract_text

Extract text from a PDF document.

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
Page Range	page_range		string	The page range to extract text from e.g. 1,5,8-12
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 PDF file using OCR - https://www.muhimbi.com/guides/pdf-converter/power-automate/extract-text-from-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
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 data and fill PDF forms - https://www.muhimbi.com/guides/pdf-converter/power-automate/fill-pdf-form/

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 file formats into a single PDF document - https://www.muhimbi.com/guides/pdf-converter/power-automate/merge-documents/

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

Encrypt and password-protect a PDF document.

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 PDF documents - https://www.muhimbi.com/guides/pdf-converter/power-automate/split-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 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.