Document Convert API API Reference
Convert API lets you effortlessly convert file formats and types.
Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client
API Endpoint
https://api.cloudmersive.comSchemes: https
Version: v1
Authentication
Apikey
API Key Authentication
CompareDocument
Compare Two Word DOCX
Compare two Office Word Documents (docx) files and highlight the differences
First input file to perform the operation on.
Second input file to perform the operation on (more than 2 can be supplied).
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
ConvertData
Convert CSV to JSON conversion
Convert a CSV file to a JSON object array
Input file to perform the operation on.
Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure.
Code Example:
OK
Response Content-Types: application/json
Response Example (200 OK)
"object"
Convert CSV to XML conversion
Convert a CSV file to a XML file
Input file to perform the operation on.
Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX to JSON conversion
Convert an Excel XLSX file to a JSON object array
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX to XML conversion
Convert an Excel XLSX file to a XML file
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel (97-2003) XLS to JSON conversion
Convert an Excel (97-2003) XLS file to a JSON object array
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json
Response Example (200 OK)
"object"
Convert XML to JSON conversion
Convert an XML string or file into JSON
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json
Response Example (200 OK)
"object"
Filter, select XML nodes using XPath expression, get results
Return the reuslts of filtering, selecting an XML document with an XPath expression
Valid XML XPath query expression
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"XmlNodes": [
"string"
],
"ResultCount": "integer (int32)"
}
Query an XML file using XQuery query, get results
Return the reuslts of querying a single XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for a single XML document as input. Provided XML document is automatically loaded as the default context; to access elements in the document, simply refer to them without a document reference, such as bookstore/book
Input XML file to perform the operation on.
Valid XML XQuery 3.1 or earlier query expression; multi-line expressions are supported
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXml": "string",
"ErrorMessage": "string"
}
Query multiple XML files using XQuery query, get results
Return the reuslts of querying an XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for multiple XML documents as input. You can refer to the contents of a given document by name, for example doc("books.xml") or doc("restaurants.xml") if you included two input files named books.xml and restaurants.xml. If input files contain no file name, they will default to file names input1.xml, input2.xml and so on.
First input XML file to perform the operation on.
Second input XML file to perform the operation on.
Third input XML file to perform the operation on.
Fourth input XML file to perform the operation on.
Fifth input XML file to perform the operation on.
Sixth input XML file to perform the operation on.
Seventh input XML file to perform the operation on.
Eighth input XML file to perform the operation on.
Ninth input XML file to perform the operation on.
Tenth input XML file to perform the operation on.
Valid XML XQuery 3.1 or earlier query expression; multi-line expressions are supported
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXml": "string",
"ErrorMessage": "string"
}
Sets the value contents of XML nodes matching XPath expression
Return the reuslts of editing an XML document by setting the contents of all of the nodes that match an input XPath expression. Supports elements and attributes.
Input XML file to perform the operation on.
Valid XML XPath query expression
XML Value to set into the matching XML nodes
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXmlDocument": "string",
"NodesEditedCount": "integer (int32)"
}
Replaces XML nodes matching XPath expression with new node
Return the reuslts of editing an XML document by replacing all of the nodes that match an input XPath expression with a new XML node expression.
Input XML file to perform the operation on.
Valid XML XPath query expression
XML Node replacement content
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXmlDocument": "string",
"NodesEditedCount": "integer (int32)"
}
Adds an XML node as a child to XML nodes matching XPath expression
Return the reuslts of editing an XML document by adding an XML node as a child to all of the nodes that match an input XPath expression.
Input XML file to perform the operation on.
Valid XML XPath query expression
XML Node to add as a child
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXmlDocument": "string",
"NodesEditedCount": "integer (int32)"
}
Adds an attribute to all XML nodes matching XPath expression
Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.
Input XML file to perform the operation on.
Valid XML XPath query expression
Name of the XML attribute to add
Value of the XML attribute to add
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXmlDocument": "string",
"NodesEditedCount": "integer (int32)"
}
Remove, delete XML nodes and items matching XPath expression
Return the reuslts of editing an XML document by removing all of the nodes that match an input XPath expression
Valid XML XPath query expression
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXmlDocument": "string",
"XmlNodesRemoved": [
"string"
],
"NodesRemovedCount": "integer (int32)"
}
Removes, deletes all children of nodes matching XPath expression, but does not remove the nodes
Return the reuslts of editing an XML document by removing all child nodes of the nodes that match an input XPath expression.
Input XML file to perform the operation on.
Valid XML XPath query expression
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ResultingXmlDocument": "string",
"NodesEditedCount": "integer (int32)"
}
Transform XML document file with XSLT into a new XML document
Convert an XML string or file into JSON
Input XML file to perform the operation on.
Input XSLT file to use to transform the input XML file.
Code Example:
OK
Response Content-Types: application/xml
Response Example (200 OK)
"string (byte)"
Convert JSON to XML conversion
Convert a JSON object into XML
Input JSON to convert to XML
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"object"
OK
Response Content-Types: application/xml
Response Example (200 OK)
"string (byte)"
ConvertDocument
Convert Word DOCX Document to PDF
Convert Office Word Documents (docx) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Word DOCX Document to Text (txt)
Convert Office Word Documents (docx) to text
Input file to perform the operation on.
Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Convert Word DOCX Document to RTF
Convert an Office Word Document (DOCX) to Rich Text Format Document (RTF)
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Word DOCX Document to PNG image array
Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert Word DOCX Document to JPG/JPEG image array
Converts an Office Word Document (DOCX) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert Word DOCX Document to HTML Document
Convert Office Word Document (DOCX) to HTML Document
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Word DOC (97-03) Document to PDF
Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Word DOC (97-03) Document to DOCX
Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Word DOCX Document to Legacy Word DOC (97-03)
Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"object"
Convert Word DOC (97-03) Document to Text (txt)
Convert Office Word DOC (97-03) Document (doc) to text
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Convert PowerPoint PPTX Presentation to PDF
Convert Office PowerPoint Documents (pptx) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PowerPoint PPTX Presentation to Text (txt)
Convert Office PowerPoint Documents (pptx) to standard Text
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Convert PowerPoint PPTX to PNG image array
Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert PowerPoint PPT (97-03) Presentation to PDF
Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PowerPoint PPT (97-03) Presentation to PPTX
Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX Spreadsheet to PDF
Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX Spreadsheet to Text (txt)
Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Convert Excel XLSX Spreadsheet to HTML Document
Convert Office Excel Spreadsheet (XLSX) to HTML Document. Converts all worksheets to HTML. Supports both XLSX and XLSB Excel file formats.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLS (97-03) Spreadsheet to PDF
Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLS (97-03) Spreadsheet to XLSX
Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLS (97-03) Spreadsheet to CSV
Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert CSV to Excel XLSX Spreadsheet
Convert CSV file to Office Excel XLSX Workbooks file format.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert CSV to PDF document
Convert Comma-Separated Values (CSV) file to PDF document.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert CSV to HTML document
Convert Comma-Separated Values (CSV) file to HTML document.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Multiple CSV Files into a Single XLSX Spreadsheet
Convert multiple Comma-Separated Values (CSV) files into a single Excel XLSX Spreadsheet, with one worksheet corresponding to each CSV file.
First input file to perform the operation on.
Second input file to perform the operation on.
Third input file to perform the operation on.
Fourth input file to perform the operation on.
Fifth input file to perform the operation on.
Sixth input file to perform the operation on.
Seventh input file to perform the operation on.
Eighth input file to perform the operation on.
Ninth input file to perform the operation on.
Tenth input file to perform the operation on.
Optional; Specify the name of each CSV's worksheet in order, separated with commas (e.g. "worksheet1,worksheet2,worksheet3"). Defaults to the names of the input CSV files. Recommended when inputting the files directly, without file names.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
Input file to perform the operation on.
Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
Input file to perform the operation on.
Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
"Successful": "boolean",
"CsvFiles": [
{
"Title": "string",
"FileContents": "string (byte)"
}
],
"FileCount": "integer (int32)"
}
Convert Excel XLSX spreadsheet to PNG image array
Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert HTML document file to PDF Document
Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
Input file to perform the operation on.
Optional: Set to true to include background graphics in the PDF, or false to not include. Default is true.
Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc. Default is 100%. Maximum is 1000%.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert HTML document file to PNG image array
Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
HTML Document file to Text (txt)
HTML document to text
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Get document type information
Auto-detects a document's type information; does not require file extension. Analyzes file contents to confirm file type. Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type. Supports over 100 image file formats, Office document file formats, PDF, and more.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"DetectedFileExtension": "string",
"DetectedMimeType": "string",
"PageCount": "integer (int64)",
"Author": "string",
"DateModified": "string (date-time)",
"AlternateFileTypeCandidates": [
{
"Probability": "number (double)",
"DetectedFileExtension": "string",
"DetectedMimeType": "string"
}
]
}
Get PNG icon byte array for the file extension
Returns a PNG icon for the given file format extension directly as a byte array. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
Optional; The desired width of the icon, preserving its aspect ratio.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Icon": "string (byte)",
"Extension": "string"
}
Get PNG icon file for the file extension
Returns a PNG icon for the given file format extension as a file for download. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
Optional; The desired width of the icon, preserving its aspect ratio.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Document to PDF
Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Document to Text (txt)
Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
Input file to perform the operation on.
Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Convert Document to PNG array
Automatically detect file type and convert it to an array of PNG images. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert Document to JPG/JPEG image array
Automatically detect file type and convert it to an array of JPG/JPEG Images. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert File to Thumbnail Image Object
Automatically detect file type and convert it to an array of PNG thumbnails, returned as an object. May specify the number of pages for multiple thumbnails; default is one thumbnail. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Returns a generic PNG thumbnail for unsupported formats. Maximum thumbnail size is 2048x2048.
Input file to perform the operation on.
Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ThumbnailPages": [
{
"Index": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert File to Thumbnail Image
Automatically detect file type and convert it to a PNG thumbnail. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files. Returns a generic PNG thumbnail for unsupported formats. Maximum thumbnail size is 2048x2048.
Input file to perform the operation on.
Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PDF to PNG Image Array
Convert PDF document to PNG array, one image per page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert PDF to JPG/JPEG image array
Converts a PDF Document to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert PNG Array to PDF
Convert an array of PNG images, one image per page, into a newly-created PDF. Supports images of different sizes as input.
First input file to perform the operation on.
Second input file to perform the operation on.
Third input file to perform the operation on.
Fourth input file to perform the operation on.
Fifth input file to perform the operation on.
Sixth input file to perform the operation on.
Seventh input file to perform the operation on.
Eighth input file to perform the operation on.
Ninth input file to perform the operation on.
Tenth input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PDF to Single PNG image
Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single "tall" image
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PDF Document to Text (txt)
PDF document to text
Input file to perform the operation on.
Optional; specify how whitespace should be handled when converting PDF to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"TextResult": "string"
}
Convert PDF to Word DOCX Document
Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PDF to Word DOCX Document based on rasterized version of the PDF
Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF. Converts a PDF at high fidelity into Word format.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert PDF to PowerPoint PPTX Presentation
Convert standard PDF to Office PowerPoint Presentation (pptx). Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Email EML file to HTML string
Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
Input file to perform the operation on.
Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
Optional; If false, the response object will not include any attachment files from the input file. Default is true.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Content": "string",
"Body": "string",
"From": "string",
"To": "string",
"Cc": "string",
"DateSent": "string",
"Subject": "string",
"Attachments": [
{
"Name": "string",
"Content": "string (byte)"
}
]
}
Convert Email EML file to PDF document
Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
Input file to perform the operation on.
Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Email EML file to PNG image array
Converts an Outlook Email File (EML) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert Email EML file to JPG/JPEG image array
Converts an Outlook Email File (EML) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert Email MSG file to HTML string
Convert Outlook Email MSG file to HTML string and attachments. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
Input file to perform the operation on.
Optional; If true, the HTML string will only include the body of the MSG. Other information such as subject will still be given as properties in the response object. Default is false.
Optional; If false, the response object will not include any attachment files from the input file. Default is true.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Content": "string",
"Body": "string",
"From": "string",
"To": "string",
"Cc": "string",
"ReceivedTime": "string",
"Subject": "string",
"Attachments": [
{
"Name": "string",
"Content": "string (byte)"
}
]
}
Convert Email MSG file to PDF document
Convert Outlook Email MSG file to PDF document. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
Input file to perform the operation on.
Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Email MSG file to PNG image array
Converts an Outlook Email Message File (MSG) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert Email MSG file to JPG/JPEG image array
Converts an Outlook Message File (MSG) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert ODT Text File to PDF
Convert Office Open Document Text File (ODT) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert ODT Text File to Word DOCX
Convert Office Open Document Text File (ODT) to Word DOCX Document
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert ODT Text File to PNG image array
Converts an Office Open Document Text File (ODT) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert ODT Text File to JPG/JPEG image array
Converts an Open Document Text File (ODT) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert ODS Spreadsheet to PDF
Convert Office Open Document Spreadsheet (ODS) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert ODS Spreadsheet to XLSX
Convert Office Open Document Spreadsheet (ODS) to Excel Spreadsheet (XLSX)
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert ODS Spreadsheet to PNG image array
Converts an Office Open Document Spreadsheet (ODS) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert ODS Spreadsheet to JPG/JPEG image array
Converts an Open Document Spreadsheet (ODS) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert ODP Presentation to PDF
Convert Office Open Document Presentation (ODP) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert ODP Presentation to PPTX
Convert Office Open Document Presentation (ODP) to PowerPoint Presentation (PPTX)
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert ODP Presentation to PNG image array
Converts an Office Open Document Presentation (ODP) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert ODP Presentation to JPG/JPEG image array
Converts an Open Document Presentation (ODP) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert Keynote Presentation (KEY) to PDF
Convert Mac Keynote Presentation (KEY) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Keynote Presentation (KEY) to PPTX
Convert Mac Keynote Presentation (KEY) to PowerPoint Presentation (PPTX)
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Keynote Presentation (KEY) to PNG image array
Converts a Mac Keynote Presentation (KEY) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert Keynote Presentation (KEY) to JPG/JPEG image array
Converts a Mac Keynote Presentation (KEY) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
Convert Rich Text Format RTF to PDF
Convert Rich Text Format Document (RTF) to standard PDF
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Rich Text Format RTF to HTML Document
Convert Rich Text Format Document (RTF) to HTML Document
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Rich Text Format RTF to DOCX Document
Convert Rich Text Format Document (RTF) to Word DOCX Document
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Rich Text Format RTF to PNG image array
Converts a Rich Text Format Document (RTF) to an array of PNG images, one for each page.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PngResultPages": [
{
"PageNumber": "integer (int32)",
"URL": "string"
}
]
}
Convert Rich Text Format RTF to JPG/JPEG image array
Converts a Rich Text Format Document (RTF) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
Input file to perform the operation on.
Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"JpgResultPages": [
{
"PageNumber": "integer (int32)",
"Content": "string (byte)"
}
]
}
ConvertImage
Image format conversion
Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Multi-page image format conversion
Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"PageCount": "integer (int32)",
"Pages": [
{
"Filename": "string",
"FileBytes": "string (byte)"
}
]
}
Change image DPI
Resize an image to have a different DPI
New DPI in pixels-per-inch, for example 300 DPI or 600 DPI
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Get information about an image
Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ColorSpace": "string",
"ColorType": "string",
"Width": "integer (int32)",
"Height": "integer (int32)",
"CompressionLevel": "integer (int32)",
"ImageHashSignature": "string",
"HasTransparency": "boolean",
"MimeType": "string",
"ImageFormat": "string",
"DPIUnit": "string",
"DPI": "number (double)",
"ColorCount": "integer (int32)",
"BitDepth": "integer (int32)",
"Comment": "string",
"ExifProfileName": "string",
"ExifValues": [
{
"Tag": "string",
"DataType": "string",
"DataValue": "string"
}
]
}
ConvertTemplate
Apply HTML template
Apply operations to fill in an HTML template, generating a final HTML result
Operations to apply to template
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"HtmlTemplate": "string",
"HtmlTemplateUrl": "string",
"Operations": [
{
"Action": "integer (int32)",
"MatchAgsint": "string",
"ReplaceWith": "string"
}
]
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"FinalHtml": "string"
}
Apply Word DOCX template
Apply operations to fill in a Word DOCX template by replacing target template/placeholder strings in the DOCX with values, generating a final Word DOCX result. For example, you could create a Word Document invoice containing strings such as "{FirstName}" and "{LastName}" and then replace these values with "John" and "Smith".
Template definition for the document, including what values to replace
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
ConvertWeb
Take screenshot of URL
Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.
Screenshot request parameters
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Url": "string",
"ExtraLoadingWait": "integer (int32)",
"ScreenshotWidth": "integer (int32)",
"ScreenshotHeight": "integer (int32)"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert a URL to PDF
Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.
URL to PDF request parameters
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Url": "string",
"ExtraLoadingWait": "integer (int32)",
"IncludeBackgroundGraphics": "boolean",
"ScaleFactor": "integer (int32)"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert website URL page to text (txt)
Converts a website URL page into text (txt); extracts text from HTML
HTML to Text request parameters
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Url": "string"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
"Successful": "boolean",
"TextContentResult": "string"
}
Convert HTML string to PDF
Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
HTML to PDF request parameters
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Html": "string",
"ExtraLoadingWait": "integer (int32)",
"IncludeBackgroundGraphics": "boolean",
"ScaleFactor": "integer (int32)"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert HTML string to PNG screenshot
Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
HTML to PNG request parameters
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Html": "string",
"ExtraLoadingWait": "integer (int32)",
"ScreenshotWidth": "integer (int32)",
"ScreenshotHeight": "integer (int32)"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert HTML string to text (txt)
Converts an HTML string input into text (txt); extracts text from HTML
HTML to Text request parameters
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Html": "string"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
"Successful": "boolean",
"TextContentResult": "string"
}
Convert HTML to Word DOCX Document
Convert HTML to Office Word Document (DOCX) format
HTML input to convert to DOCX
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"Html": "string"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Convert Markdown to HTML
Convert a markdown file (.md) to HTML
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
"Successful": "boolean",
"Html": "string"
}
EditDocument
Begin editing a document
Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"
Finish editing document, and download result from document editing
Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
Cloudmersive Document URL to complete editing on
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileUrl": "string"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Create a blank Word DOCX document
Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InitialText": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Replace string in Word DOCX document
Replace all instances of a string in an Office Word Document (docx)
Document string replacement configuration input
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"MatchString": "string",
"ReplaceString": "string",
"MatchCase": "boolean"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Replace multiple strings in Word DOCX document
Replace all instances of multiple strings in an Office Word Document (docx)
Document string replacement configuration input
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"ReplaceStrings": [
{
"MatchString": "string",
"ReplaceString": "string",
"MatchCase": "boolean"
}
]
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Replace string in PowerPoint PPTX presentation
Replace all instances of a string in an Office PowerPoint Document (pptx)
Replacement document configuration input
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"MatchString": "string",
"ReplaceString": "string",
"MatchCase": "boolean"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Get macro information from a PowerPoint PPTX/PPTM presentation document
Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ContainsVbaMacros": "boolean"
}
Get all metadata properties in Word DOCX document
Returns all the metadata properties in an Office Word Document (docx)
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Company": "string",
"Manager": "string",
"ApplicationVersion": "string",
"WordCount": "integer (int64)",
"LineCount": "integer (int64)",
"ParagraphCount": "integer (int64)",
"PageCount": "integer (int64)",
"CustomProperties": [
{
"PropertyName": "string",
"PropertyDataType": "string",
"StringValue": "string",
"IntegerValue": "integer (int64)",
"DoubleValue": "number (double)",
"DateValue": "string (date-time)"
}
],
"Successful": "boolean"
}
Set custom property metadata properties in Word DOCX document
Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
undefined
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"PropertiesToSet": [
{
"PropertyName": "string",
"PropertyDataType": "string",
"StringValue": "string",
"IntegerValue": "integer (int64)",
"DoubleValue": "number (double)",
"DateValue": "string (date-time)"
}
]
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"
Get all tables in Word DOCX document
Returns all the table objects in an Office Word Document (docx)
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Tables": [
{
"TableID": "string",
"Path": "string",
"Width": "string",
"WidthType": "string",
"TableRows": [
{
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
}
],
"TopBorderType": "string",
"TopBorderSize": "integer (int32)",
"TopBorderSpace": "integer (int32)",
"TopBorderColor": "string",
"BottomBorderType": "string",
"BottomBorderSize": "integer (int32)",
"BottomBorderSpace": "integer (int32)",
"BottomBorderColor": "string",
"LeftBorderType": "string",
"LeftBorderSize": "integer (int32)",
"LeftBorderSpace": "integer (int32)",
"LeftBorderColor": "string",
"RightBorderType": "string",
"RightBorderSize": "integer (int32)",
"RightBorderSpace": "integer (int32)",
"RightBorderColor": "string",
"CellHorizontalBorderType": "string",
"CellHorizontalBorderSize": "integer (int32)",
"CellHorizontalBorderSpace": "integer (int32)",
"CellHorizontalBorderColor": "string",
"CellVerticalBorderType": "string",
"CellVerticalBorderSize": "integer (int32)",
"CellVerticalBorderSpace": "integer (int32)",
"CellVerticalBorderColor": "string",
"StartBorderType": "string",
"StartBorderSize": "integer (int32)",
"StartBorderSpace": "integer (int32)",
"StartBorderColor": "string",
"EndBorderType": "string",
"EndBorderSize": "integer (int32)",
"EndBorderSpace": "integer (int32)",
"EndBorderColor": "string",
"TableIndentationMode": "string",
"TableIndentationWidth": "integer (int32)"
}
]
}
Get a specific table by index in a Word DOCX document
Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"TableIndex": "integer (int32)"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Table": {
"TableID": "string",
"Path": "string",
"Width": "string",
"WidthType": "string",
"TableRows": [
{
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
}
],
"TopBorderType": "string",
"TopBorderSize": "integer (int32)",
"TopBorderSpace": "integer (int32)",
"TopBorderColor": "string",
"BottomBorderType": "string",
"BottomBorderSize": "integer (int32)",
"BottomBorderSpace": "integer (int32)",
"BottomBorderColor": "string",
"LeftBorderType": "string",
"LeftBorderSize": "integer (int32)",
"LeftBorderSpace": "integer (int32)",
"LeftBorderColor": "string",
"RightBorderType": "string",
"RightBorderSize": "integer (int32)",
"RightBorderSpace": "integer (int32)",
"RightBorderColor": "string",
"CellHorizontalBorderType": "string",
"CellHorizontalBorderSize": "integer (int32)",
"CellHorizontalBorderSpace": "integer (int32)",
"CellHorizontalBorderColor": "string",
"CellVerticalBorderType": "string",
"CellVerticalBorderSize": "integer (int32)",
"CellVerticalBorderSpace": "integer (int32)",
"CellVerticalBorderColor": "string",
"StartBorderType": "string",
"StartBorderSize": "integer (int32)",
"StartBorderSpace": "integer (int32)",
"StartBorderColor": "string",
"EndBorderType": "string",
"EndBorderSize": "integer (int32)",
"EndBorderSpace": "integer (int32)",
"EndBorderColor": "string",
"TableIndentationMode": "string",
"TableIndentationWidth": "integer (int32)"
}
}
Get images from a Word DOCX document
Returns the images defined in the Word Document (DOCX) format file
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Images": [
{
"Path": "string",
"ImageName": "string",
"ImageId": "integer (int64)",
"ImageDescription": "string",
"ImageWidth": "integer (int64)",
"ImageHeight": "integer (int64)",
"XOffset": "integer (int64)",
"YOffset": "integer (int64)",
"ImageDataEmbedId": "string",
"ImageDataContentType": "string",
"ImageInternalFileName": "string",
"ImageContentsURL": "string",
"InlineWithText": "boolean"
}
]
}
Get macro information from a Word DOCX/DOCM document
Returns information about the Macros (e.g. VBA) defined in the Word Document
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"ContainsVbaMacros": "boolean"
}
Get styles from a Word DOCX document
Returns the styles defined in the Word Document (DOCX) format file
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Styles": [
{
"StyleID": "string",
"Path": "string",
"Bold": "boolean",
"Italic": "boolean",
"Underline": "boolean",
"FontSize": "string",
"FontFamily": "string"
}
]
}
Get sections from a Word DOCX document
Returns the sections defined in the Word Document (DOCX) format file
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Sections": [
{
"StartingPageNumbers": [
"integer (int32)"
],
"Path": "string"
}
]
}
Get body from a Word DOCX document
Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Body": {
"Path": "string",
"AllParagraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"AllTables": [
{
"TableID": "string",
"Path": "string",
"Width": "string",
"WidthType": "string",
"TableRows": [
{
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
}
],
"TopBorderType": "string",
"TopBorderSize": "integer (int32)",
"TopBorderSpace": "integer (int32)",
"TopBorderColor": "string",
"BottomBorderType": "string",
"BottomBorderSize": "integer (int32)",
"BottomBorderSpace": "integer (int32)",
"BottomBorderColor": "string",
"LeftBorderType": "string",
"LeftBorderSize": "integer (int32)",
"LeftBorderSpace": "integer (int32)",
"LeftBorderColor": "string",
"RightBorderType": "string",
"RightBorderSize": "integer (int32)",
"RightBorderSpace": "integer (int32)",
"RightBorderColor": "string",
"CellHorizontalBorderType": "string",
"CellHorizontalBorderSize": "integer (int32)",
"CellHorizontalBorderSpace": "integer (int32)",
"CellHorizontalBorderColor": "string",
"CellVerticalBorderType": "string",
"CellVerticalBorderSize": "integer (int32)",
"CellVerticalBorderSpace": "integer (int32)",
"CellVerticalBorderColor": "string",
"StartBorderType": "string",
"StartBorderSize": "integer (int32)",
"StartBorderSpace": "integer (int32)",
"StartBorderColor": "string"
}
]
}
}
Find matching paragraphs in a Word DOCX document
Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"FindString": "string",
"MatchCase": "boolean"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"MatchingParagraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"Count": "integer (int32)"
}
Replace matching paragraphs in a Word DOCX document
Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"FindString": "string",
"MatchCase": "boolean",
"Replacement_Image": {
"Path": "string",
"ImageName": "string",
"ImageId": "integer (int64)",
"ImageDescription": "string",
"ImageWidth": "integer (int64)",
"ImageHeight": "integer (int64)",
"XOffset": "integer (int64)",
"YOffset": "integer (int64)",
"ImageDataEmbedId": "string",
"ImageDataContentType": "string",
"ImageInternalFileName": "string",
"ImageContentsURL": "string",
"InlineWithText": "boolean"
}
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Get pages and content from a Word DOCX document
Returns the pages and contents of each page defined in the Word Document (DOCX) format file
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"MaximumPages": "integer (int32)"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Pages": [
{
"PageNumber": "integer (int32)",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
]
}
],
"PageCount": "integer (int32)"
}
Get comments from a Word DOCX document as a flat list
Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Comments": [
{
"Path": "string",
"Author": "string",
"AuthorInitials": "string",
"CommentText": "string",
"CommentDate": "string (date-time)",
"IsTopLevel": "boolean",
"IsReply": "boolean",
"ParentCommentPath": "string",
"Done": "boolean"
}
],
"CommentCount": "integer (int32)"
}
Get comments from a Word DOCX document hierarchically
Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"Comments": [
{
"Path": "string",
"Author": "string",
"AuthorInitials": "string",
"CommentText": "string",
"CommentDate": "string (date-time)",
"ReplyChildComments": [
{
"Path": "string",
"Author": "string",
"AuthorInitials": "string",
"CommentText": "string",
"CommentDate": "string (date-time)",
"IsTopLevel": "boolean",
"IsReply": "boolean",
"ParentCommentPath": "string",
"Done": "boolean"
}
],
"Done": "boolean"
}
],
"TopLevelCommentCount": "integer (int32)"
}
Remove all comments from a Word DOCX document
Removes all of the comments from a Word Document.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"
Enable track changes, revisions in a Word DOCX document
Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"
Disable track changes, revisions in a Word DOCX document
Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"
Accept all tracked changes, revisions in a Word DOCX document
Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
Input file to perform the operation on.
Code Example:
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"
Insert a new comment into a Word DOCX document attached to a paragraph
Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"ParagraphPath": "string",
"CommentToInsert": {
"Path": "string",
"Author": "string",
"AuthorInitials": "string",
"CommentText": "string",
"CommentDate": "string (date-time)",
"IsTopLevel": "boolean",
"IsReply": "boolean",
"ParentCommentPath": "string",
"Done": "boolean"
}
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Delete, remove pages from a Word DOCX document
Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"StartDeletePageNumber": "integer (int32)",
"EndDeletePageNumber": "integer (int32)"
}
OK
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Set the header in a Word DOCX document
Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"HeaderToApply": {
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"SectionsWithHeader": [
{
"StartingPageNumbers": [
"integer (int32)"
],
"Path": "string"
}
]
}
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Insert image into a Word DOCX document
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputDocumentFileBytes": "string (byte)",
"InputDocumentFileUrl": "string",
"InputImageFileBytes": "string (byte)",
"InputImageFileUrl": "string",
"ImageToAdd": {
"Path": "string",
"ImageName": "string",
"ImageId": "integer (int64)",
"ImageDescription": "string",
"ImageWidth": "integer (int64)",
"ImageHeight": "integer (int64)",
"XOffset": "integer (int64)",
"YOffset": "integer (int64)",
"ImageDataEmbedId": "string",
"ImageDataContentType": "string",
"ImageInternalFileName": "string",
"ImageContentsURL": "string",
"InlineWithText": "boolean"
},
"InsertPlacement": "string",
"InsertPath": "string",
"WidthInEMUs": "integer (int64)",
"HeightInEMUs": "integer (int64)"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Insert a new paragraph into a Word DOCX document
Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"ParagraphToInsert": {
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
},
"InsertPlacement": "string",
"InsertPath": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Insert a new table into a Word DOCX document
Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"TableToInsert": {
"TableID": "string",
"Path": "string",
"Width": "string",
"WidthType": "string",
"TableRows": [
{
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
}
],
"TopBorderType": "string",
"TopBorderSize": "integer (int32)",
"TopBorderSpace": "integer (int32)",
"TopBorderColor": "string",
"BottomBorderType": "string",
"BottomBorderSize": "integer (int32)",
"BottomBorderSpace": "integer (int32)",
"BottomBorderColor": "string",
"LeftBorderType": "string",
"LeftBorderSize": "integer (int32)",
"LeftBorderSpace": "integer (int32)",
"LeftBorderColor": "string",
"RightBorderType": "string",
"RightBorderSize": "integer (int32)",
"RightBorderSpace": "integer (int32)",
"RightBorderColor": "string",
"CellHorizontalBorderType": "string",
"CellHorizontalBorderSize": "integer (int32)",
"CellHorizontalBorderSpace": "integer (int32)",
"CellHorizontalBorderColor": "string",
"CellVerticalBorderType": "string",
"CellVerticalBorderSize": "integer (int32)",
"CellVerticalBorderSpace": "integer (int32)",
"CellVerticalBorderColor": "string",
"StartBorderType": "string",
"StartBorderSize": "integer (int32)",
"StartBorderSpace": "integer (int32)",
"StartBorderColor": "string",
"EndBorderType": "string",
"EndBorderSize": "integer (int32)",
"EndBorderSpace": "integer (int32)",
"EndBorderColor": "string",
"TableIndentationMode": "string",
"TableIndentationWidth": "integer (int32)"
},
"InsertPlacement": "string",
"InsertPath": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Gets the contents of an existing table row in an existing table in a Word DOCX document
Gets the contents of an existing table row in a Word DOCX Document and returns the result.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"TablePath": "string",
"TableRowRowIndex": "integer (int32)"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"RowResult": {
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
}
}
Deletes a table row in an existing table in a Word DOCX document
Deletes an existing table row in a Word DOCX Document and returns the result.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"TablePath": "string",
"TableRowRowIndex": "integer (int32)"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Deletes a range of multiple table rows in an existing table in a Word DOCX document
Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"TablePath": "string",
"TableRowRowIndexStart": "integer (int32)",
"TableRowRowIndexEnd": "integer (int32)"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Insert a new row into an existing table in a Word DOCX document
Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"RowToInsert": {
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
},
"InsertPlacement": "string",
"ExistingTablePath": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}
Update, set contents of a table row in an existing table in a Word DOCX document
Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
Document input request
Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"InputFileBytes": "string (byte)",
"InputFileUrl": "string",
"RowToUpdate": {
"RowIndex": "integer (int32)",
"Path": "string",
"RowCells": [
{
"CellIndex": "integer (int32)",
"Path": "string",
"Paragraphs": [
{
"ParagraphIndex": "integer (int32)",
"Path": "string",
"ContentRuns": [
{
"RunIndex": "integer (int32)",
"Path": "string",
"TextItems": [
{
"TextIndex": "integer (int32)",
"Path": "string",
"TextContent": "string"
}
],
"Bold": "boolean",
"Italic": "boolean",
"Underline": "string",
"FontFamily": "string",
"FontSize": "string"
}
],
"StyleID": "string"
}
],
"CellShadingColor": "string",
"CellShadingFill": "string",
"CellShadingPattern": "string",
"CellWidthMode": "string",
"CellWidth": "string"
}
]
},
"TableRowIndex": "integer (int32)",
"ExistingTablePath": "string"
}
OK
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
"Successful": "boolean",
"EditedDocumentURL": "string"
}