Cloudmersive Document Conversion (Preview)

Convert API lets you effortlessly convert file formats and types.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

This connector is critical for any document conversion and processing application to convert documents and files between formats at very high fidelity. Cloudmersive Document Conversion covers a wide array of common file formats, including Word (DOCX), Excel (XLSX), PowerPoint (PPTX), PDF, PNG and over 100 other file formats. Stateless high-security processing ensures fast performance and strong security. You can learn more at the Document Convert API page.

To use this connector, you need a Cloudmersive account. You can sign up with a Microsoft Account or create a Cloudmersive account. Follow the steps below to get your API Key.

Get the API Key and Secret

  • Register for a Cloudmersive Account
  • Sign In with your Cloudmersive Account and click on API Keys

Here you can create and see your API key(s) listed on the API Keys page. Simply copy and paste this API Key into the Cloudmersive Document Convert Connector.

Now you are ready to start using the Cloudmersive Document Convert Connector.

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key (from https://cloudmersive.com) securestring

The Api Key for this API

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add page number to footer in a Word DOCX document

Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.

Apply HTML template

Apply operations to fill in an HTML template, generating a final HTML result

Autodetect content type and validate

Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.

Begin editing a document

Uploads a document to Cloudmersive to begin a series of one or more editing operations

Change image DPI

Resize an image to have a different DPI

Compare Two Word DOCX

Compare two Office Word Documents (docx) files and highlight the differences

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.

Convert CSV to Excel XLSX Spreadsheet

Convert CSV file to Office Excel XLSX Workbooks file format.

Convert CSV to JSON conversion

Convert a CSV file to a JSON object array

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.

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.

Convert Document to Text

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.

Convert Excel (97-2003) XLS to JSON conversion

Convert an Excel (97-2003) XLS file to a JSON object array

Convert Excel XLS (97-03) Spreadsheet to CSV

Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.

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.

Convert Excel XLS (97-03) Spreadsheet to XLSX

Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.

Convert Excel XLSX Spreadsheet to CSV

Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.

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.

Convert Excel XLSX Spreadsheet to Text

Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats.

Convert Excel XLSX to JSON conversion

Convert an Excel XLSX file to a JSON object array

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.

Convert HTML string to PNG

Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.

Convert HTML 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.

Convert HTML 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.

Convert HTML to Word DOCX Document

Convert HTML to Office Word Document (DOCX) format

Convert Markdown to HTML

Convert a markdown file (.md) to HTML

Convert PDF Document to Text

PDF document to text

Convert PDF to PNG Image Array

Convert PDF document to PNG array, one image per page.

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.

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

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.

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.

Convert PowerPoint PPT (97-03) Presentation to PDF

Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF

Convert PowerPoint PPT (97-03) Presentation to PPTX

Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX

Convert PowerPoint PPTX Presentation to PDF

Convert Office PowerPoint Documents (pptx) to standard PDF

Convert PowerPoint PPTX Presentation to Text

Convert Office PowerPoint Documents (pptx) to standard Text

Convert Word DOC (97-03) Document to DOCX

Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format

Convert Word DOC (97-03) Document to PDF

Convert Office Word (97-2003 Format) Documents (doc) to standard PDF

Convert Word DOCX Document to PDF

Convert Office Word Documents (docx) to standard PDF

Convert Word DOCX Document to Text

Convert Office Word Documents (docx) to text

Convert XML to JSON conversion

Convert an XML string or file into JSON

Create a web-based viewer

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

Delete, remove pages from a Word DOCX document

Returns the pages and contents of each page defined in the Word Document (DOCX) format file

Delete any object in a Word DOCX document

Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.

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.

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

Get content of a footer from a Word DOCX document

Returns the footer content from a Word Document (DOCX) format file

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.

Get images from a Excel XLSX spreadsheet, worksheet

Returns the images defined in the Excel Spreadsheet worksheet

Get images from a Word DOCX document

Returns the images defined in the Word Document (DOCX) format file

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

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

Get rows and cells from a Excel XLSX spreadsheet, worksheet

Returns the rows and cells defined in the Excel Spreadsheet worksheet

Get rows and cells from a Word XLSX spreadsheet, worksheet

Returns the rows and cells defined in the Excel Spreadsheet worksheet

Get sections from a Word DOCX document

Returns the sections defined in the Word Document (DOCX) format file

Get styles from a Excel XLSX spreadsheet, worksheet

Returns the style defined in the Excel Spreadsheet

Get styles from a Word DOCX document

Returns the styles defined in the Word Document (DOCX) format file

Get tables in Word DOCX document

Returns all the table objects in an Office Word Document (docx)

Get worksheets from a Excel XLSX spreadsheet

Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

Image format conversion

Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.

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.

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.

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.

Insert a new worksheet into an Excel XLSX spreadsheet

Inserts a new worksheet into an Excel Spreadsheet

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.

Merge Multple Excel XLSX Together

Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Merge Multple PDF Files Together

Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Merge Multple PNG Files Together

Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Merge Multple PowerPoint PPTX Together

Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Merge Multple Word DOCX Together

Combine multiple Office Word Documents (docx) into one single Office Word document

Merge Two Excel XLSX Together

Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Merge Two PDF Files Together

Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Merge Two PowerPoint PPTX Together

Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Merge Two Word DOCX Together

Combine two Office Word Documents (docx) into one single Office Word document

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).

Remove headers and footers from Word DOCX document

Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Replace string in PowerPoint PPTX presentation

Replace all instances of a string in an Office PowerPoint Document (pptx)

Replace string in Word DOCX document

Replace all instances of a string in an Office Word Document (docx)

Set the footer in a Word DOCX document

Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

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.

Split a PDF file into separate PDF files, one per page

Split an input PDF file into separate pages, comprised of one PDF file per page.

Split a single Excel XLSX into Separate Worksheets

Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

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.

Validate a Excel document (XLSX)

Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document

Validate a JSON file

Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document

Validate a PDF document file

Validate a PDF document; if the document is not valid, identifies the errors in the document

Validate a PowerPoint presentation (PPTX)

Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document

Validate a Word document (DOCX)

Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

Validate an XML file

Validate an XML document file; if the document is not valid, identifies the errors in the document

Validate if a file is executable

Validate if an input file is a binary executable file; if the document is not valid

Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

PrependText
PrependText string

Optional: extra text to add before the page number, for example if you want to show "Page 1" then you can set PrependText to "Page"

Returns

Result of running a set-footer command

Apply HTML template

Apply operations to fill in an HTML template, generating a final HTML result

Parameters

Name Key Required Type Description
HtmlTemplate
HtmlTemplate string

HTML template input as a string

HtmlTemplateUrl
HtmlTemplateUrl string

URL to HTML template input

Action
Action integer

Operation action to take; possible values are "Replace"

MatchAgsint
MatchAgsint string

For Replace operations, the string to match against (to be replaced with ReplaceWith string)

ReplaceWith
ReplaceWith string

For Replace operations, the string to Replace the original string with

Returns

Response from an HTML template application

Autodetect content type and validate

Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Begin editing a document

Uploads a document to Cloudmersive to begin a series of one or more editing operations

Parameters

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

Input file to perform the operation on.

Change image DPI

Resize an image to have a different DPI

Parameters

Name Key Required Type Description
New DPI in pixels-per-inch, for example 300 DPI or 600 DPI
dpi True integer

New DPI in pixels-per-inch, for example 300 DPI or 600 DPI

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Compare Two Word DOCX

Compare two Office Word Documents (docx) files and highlight the differences

Parameters

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

First input file to perform the operation on.

Second input file to perform the operation on (more than 2 can be supplied).
inputFile2 True file

Second input file to perform the operation on (more than 2 can be supplied).

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

Name Key Required Type Description
ExtraLoadingWait
ExtraLoadingWait integer

Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds)

ScreenshotHeight
ScreenshotHeight integer

Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

ScreenshotWidth
ScreenshotWidth integer

Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

Url
Url string

URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports.

Returns

Output file content from the operation

OutputContent
binary

Convert CSV to Excel XLSX Spreadsheet

Convert CSV file to Office Excel XLSX Workbooks file format.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert CSV to JSON conversion

Convert a CSV file to a JSON object array

Parameters

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

Input file to perform the operation on.

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.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

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

Input file to perform the operation on.

Returns

Result of converting an autodetected input to a PNG array

Convert Document to Text

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.

Parameters

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

Input file to perform the operation on.

Returns

Text conversion result from converting a document to Plain Text (TXT) format

Convert Excel (97-2003) XLS to JSON conversion

Convert an Excel (97-2003) XLS file to a JSON object array

Parameters

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

Input file to perform the operation on.

Convert Excel XLS (97-03) Spreadsheet to CSV

Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert Excel XLS (97-03) Spreadsheet to XLSX

Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert Excel XLSX Spreadsheet to CSV

Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.

Parameters

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

Input file to perform the operation on.

Optional, set the output text encoding for the result; possible values...
outputEncoding string

Optional, set the output text encoding for the result; possible values...

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert Excel XLSX Spreadsheet to Text

Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats.

Parameters

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

Input file to perform the operation on.

Returns

Text conversion result from converting a document to Plain Text (TXT) format

Convert Excel XLSX to JSON conversion

Convert an Excel XLSX file to a JSON object array

Parameters

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

Input file to perform the operation on.

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.

Parameters

Name Key Required Type Description
ExtraLoadingWait
ExtraLoadingWait integer

Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites.

Html
Html string

HTML to render to PDF

Returns

Output file content from the operation

OutputContent
binary

Convert HTML string to PNG

Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.

Parameters

Name Key Required Type Description
ExtraLoadingWait
ExtraLoadingWait integer

Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites.

Html
Html string

HTML to render to PNG (screenshot)

ScreenshotHeight
ScreenshotHeight integer

Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

ScreenshotWidth
ScreenshotWidth integer

Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

Convert HTML 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.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert HTML 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.

Parameters

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

Input file to perform the operation on.

Returns

Result of converting a PDF to a PNG array

Convert HTML to Word DOCX Document

Convert HTML to Office Word Document (DOCX) format

Parameters

Name Key Required Type Description
Html
Html string

HTML to render to Office format

Returns

Output file content from the operation

OutputContent
binary

Convert Markdown to HTML

Convert a markdown file (.md) to HTML

Parameters

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

Input file to perform the operation on.

Returns

Result from converting a Markdown file to HTML

Convert PDF Document to Text

PDF document to text

Parameters

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

Input file to perform the operation on.

Returns

Text conversion result from converting a document to Plain Text (TXT) format

Convert PDF to PNG Image Array

Convert PDF document to PNG array, one image per page.

Parameters

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

Input file to perform the operation on.

Returns

Result of converting a PDF to a PNG array

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.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

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

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

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

First input file to perform the operation on.

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

Second input file to perform the operation on.

Third input file to perform the operation on.
inputFile3 file

Third input file to perform the operation on.

Fourth input file to perform the operation on.
inputFile4 file

Fourth input file to perform the operation on.

Fifth input file to perform the operation on.
inputFile5 file

Fifth input file to perform the operation on.

Sixth input file to perform the operation on.
inputFile6 file

Sixth input file to perform the operation on.

Seventh input file to perform the operation on.
inputFile7 file

Seventh input file to perform the operation on.

Eighth input file to perform the operation on.
inputFile8 file

Eighth input file to perform the operation on.

Ninth input file to perform the operation on.
inputFile9 file

Ninth input file to perform the operation on.

Tenth input file to perform the operation on.
inputFile10 file

Tenth input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert PowerPoint PPT (97-03) Presentation to PDF

Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert PowerPoint PPT (97-03) Presentation to PPTX

Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert PowerPoint PPTX Presentation to PDF

Convert Office PowerPoint Documents (pptx) to standard PDF

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert PowerPoint PPTX Presentation to Text

Convert Office PowerPoint Documents (pptx) to standard Text

Parameters

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

Input file to perform the operation on.

Returns

Text conversion result from converting a document to Plain Text (TXT) format

Convert Word DOC (97-03) Document to DOCX

Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert Word DOC (97-03) Document to PDF

Convert Office Word (97-2003 Format) Documents (doc) to standard PDF

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert Word DOCX Document to PDF

Convert Office Word Documents (docx) to standard PDF

Parameters

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

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Convert Word DOCX Document to Text

Convert Office Word Documents (docx) to text

Parameters

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

Input file to perform the operation on.

Returns

Text conversion result from converting a document to Plain Text (TXT) format

Convert XML to JSON conversion

Convert an XML string or file into JSON

Parameters

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

Input file to perform the operation on.

Create a web-based viewer

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

Parameters

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

Input file to perform the operation on.

Returns

Result of creating a viewer

Delete, remove pages from a Word DOCX document

Returns the pages and contents of each page defined in the Word Document (DOCX) format file

Parameters

Name Key Required Type Description
EndDeletePageNumber
EndDeletePageNumber integer

Page number (1-based) to stop deleting pages; inclusive

InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

StartDeletePageNumber
StartDeletePageNumber integer

Page number (1-based) to start deleting pages; inclusive

Returns

Output file content from the operation

OutputContent
binary

Delete any object in a Word DOCX document

Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

PathToObjectToRemove
PathToObjectToRemove string

Path within the document of the object to delete; fill in the PathToObjectToRemove field using the Path value from an existing object.

Returns

Result of running an Remove-Object command

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.

Parameters

Name Key Required Type Description
InputFileUrl
InputFileUrl string

URL of a document being edited to get the contents of.

Returns

Output file content from the operation

OutputContent
binary

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

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Body command

Returns the footer content from a Word Document (DOCX) format file

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Tables command

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.

Parameters

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

Input file to perform the operation on.

Returns

Result of an autodetect/get-info operation

Get images from a Excel XLSX spreadsheet, worksheet

Returns the images defined in the Excel Spreadsheet worksheet

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Path
Path string

The Path of the location of this object; leave blank for new worksheets

WorksheetName
WorksheetName string

User-facing name of the worksheet tab

Returns

Result of running a Get-Images command

Get images from a Word DOCX document

Returns the images defined in the Word Document (DOCX) format file

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Images command

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

Parameters

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

Input file to perform the operation on.

Returns

Result of running a get-info operation on an image

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

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Get rows and cells from a Excel XLSX spreadsheet, worksheet

Returns the rows and cells defined in the Excel Spreadsheet worksheet

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Path
Path string

The Path of the location of this object; leave blank for new worksheets

WorksheetName
WorksheetName string

User-facing name of the worksheet tab

Returns

Result of running a Get-Columns command

Get rows and cells from a Word XLSX spreadsheet, worksheet

Returns the rows and cells defined in the Excel Spreadsheet worksheet

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Path
Path string

The Path of the location of this object; leave blank for new worksheets

WorksheetName
WorksheetName string

User-facing name of the worksheet tab

Returns

Result of running a Get-Worksheets command

Get sections from a Word DOCX document

Returns the sections defined in the Word Document (DOCX) format file

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Sections command

Get styles from a Excel XLSX spreadsheet, worksheet

Returns the style defined in the Excel Spreadsheet

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Worksheets command

Get styles from a Word DOCX document

Returns the styles defined in the Word Document (DOCX) format file

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Tables command

Get tables in Word DOCX document

Returns all the table objects in an Office Word Document (docx)

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Tables command

Get worksheets from a Excel XLSX spreadsheet

Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a Get-Worksheets command

Image format conversion

Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.

Parameters

Name Key Required Type Description
Input file format as a 3+ letter file extension. You can also provide...
format1 True string

Input file format as a 3+ letter file extension. You can also provide...

Output (convert to this format) file format as a 3+ letter file extens...
format2 True string

Output (convert to this format) file format as a 3+ letter file extens...

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

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.

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

InsertPath
InsertPath string

Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject

InsertPlacement
InsertPlacement string

Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)

Bold
Bold boolean

True to make the text bold, false otherwise

FontFamily
FontFamily string

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize
FontSize string

Font size in font points (e.g. "24")

Italic
Italic boolean

True to make the text italic, false otherwise

Path
Path string

The Path of the location of this object; leave blank for new tables

RunIndex
RunIndex integer

Index of the run, 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

TextContent
TextContent string

Text string containing the text content of this text content item

TextIndex
TextIndex integer

Index of the text content in the run; 0-based

Underline
Underline string

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None

ParagraphIndex
ParagraphIndex integer

The index of the paragraph; 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

Style ID of the style applied to the paragraph; null if no style is applied

Returns

Result of running an Insert-Paragraph command

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.

Parameters

Name Key Required Type Description
ExistingTablePath
ExistingTablePath string

Required; the path to the existing table to modify

InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

InsertPlacement
InsertPlacement string

Optional; default is TableEnd. Placement Type of the insert; possible values are: TableStart (very beginning of the table), TableEnd (very end of the document), or a 0-based row index number as an integer, 0 being the first row in the table, 1 being the second row in the table, 2 being the third row in the table, etc. to insert this row after

Path
Path string

The Path of the location of this object; leave blank for new tables

CellIndex
CellIndex integer

The index of the cell, 0-based

CellShadingColor
CellShadingColor string

Color of the cell shading

CellShadingFill
CellShadingFill string

Fill of the cell shading

CellShadingPattern
CellShadingPattern string

Pattern of the cell shading

CellWidth
CellWidth string

Width of the cell

CellWidthMode
CellWidthMode string

Width mode of the cell; can be auto (for automatic) or manual

Bold
Bold boolean

True to make the text bold, false otherwise

FontFamily
FontFamily string

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize
FontSize string

Font size in font points (e.g. "24")

Italic
Italic boolean

True to make the text italic, false otherwise

Path
Path string

The Path of the location of this object; leave blank for new tables

RunIndex
RunIndex integer

Index of the run, 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

TextContent
TextContent string

Text string containing the text content of this text content item

TextIndex
TextIndex integer

Index of the text content in the run; 0-based

Underline
Underline string

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None

ParagraphIndex
ParagraphIndex integer

The index of the paragraph; 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

Style ID of the style applied to the paragraph; null if no style is applied

Path
Path string

The Path of the location of this object; leave blank for new tables

RowIndex
RowIndex integer

Index of the row, 0-based

Returns

Result of running an Insert-Table Row command

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.

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

InsertPath
InsertPath string

Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject

InsertPlacement
InsertPlacement string

Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)

BottomBorderColor
BottomBorderColor string

HTML-style color hex value (do not include a #)

BottomBorderSize
BottomBorderSize integer

Width of the border in points (1/72nd of an inch)

BottomBorderSpace
BottomBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

BottomBorderType
BottomBorderType string

Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

CellHorizontalBorderColor
CellHorizontalBorderColor string

HTML-style color hex value (do not include a #)

CellHorizontalBorderSize
CellHorizontalBorderSize integer

Width of the border in points (1/72nd of an inch)

CellHorizontalBorderSpace
CellHorizontalBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

CellHorizontalBorderType
CellHorizontalBorderType string

Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

CellVerticalBorderColor
CellVerticalBorderColor string

HTML-style color hex value (do not include a #)

CellVerticalBorderSize
CellVerticalBorderSize integer

Width of the border in points (1/72nd of an inch)

CellVerticalBorderSpace
CellVerticalBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

CellVerticalBorderType
CellVerticalBorderType string

Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

EndBorderColor
EndBorderColor string

HTML-style color hex value (do not include a #)

EndBorderSize
EndBorderSize integer

Width of the border in points (1/72nd of an inch)

EndBorderSpace
EndBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

EndBorderType
EndBorderType string

Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

LeftBorderColor
LeftBorderColor string

HTML-style color hex value (do not include a #)

LeftBorderSize
LeftBorderSize integer

Width of the border in points (1/72nd of an inch)

LeftBorderSpace
LeftBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

LeftBorderType
LeftBorderType string

Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

Path
Path string

The Path of the location of this object; leave blank for new tables

RightBorderColor
RightBorderColor string

HTML-style color hex value (do not include a #)

RightBorderSize
RightBorderSize integer

Width of the border in points (1/72nd of an inch)

RightBorderSpace
RightBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

RightBorderType
RightBorderType string

Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

StartBorderColor
StartBorderColor string

HTML-style color hex value (do not include a #)

StartBorderSize
StartBorderSize integer

Width of the border in points (1/72nd of an inch)

StartBorderSpace
StartBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

StartBorderType
StartBorderType string

Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

TableID
TableID string

The ID of the table; leave blank for new tables

TableIndentationMode
TableIndentationMode string

Table indentation type

TableIndentationWidth
TableIndentationWidth integer

Table indentation width

Path
Path string

The Path of the location of this object; leave blank for new tables

CellIndex
CellIndex integer

The index of the cell, 0-based

CellShadingColor
CellShadingColor string

Color of the cell shading

CellShadingFill
CellShadingFill string

Fill of the cell shading

CellShadingPattern
CellShadingPattern string

Pattern of the cell shading

CellWidth
CellWidth string

Width of the cell

CellWidthMode
CellWidthMode string

Width mode of the cell; can be auto (for automatic) or manual

Bold
Bold boolean

True to make the text bold, false otherwise

FontFamily
FontFamily string

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize
FontSize string

Font size in font points (e.g. "24")

Italic
Italic boolean

True to make the text italic, false otherwise

Path
Path string

The Path of the location of this object; leave blank for new tables

RunIndex
RunIndex integer

Index of the run, 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

TextContent
TextContent string

Text string containing the text content of this text content item

TextIndex
TextIndex integer

Index of the text content in the run; 0-based

Underline
Underline string

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None

ParagraphIndex
ParagraphIndex integer

The index of the paragraph; 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

Style ID of the style applied to the paragraph; null if no style is applied

Path
Path string

The Path of the location of this object; leave blank for new tables

RowIndex
RowIndex integer

Index of the row, 0-based

TopBorderColor
TopBorderColor string

HTML-style color hex value (do not include a #)

TopBorderSize
TopBorderSize integer

Width of the border in points (1/72nd of an inch)

TopBorderSpace
TopBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

TopBorderType
TopBorderType string

Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

Width
Width string

The Width of the table, or 0 if not specified

WidthType
WidthType string

The Width configuration type of the table

Returns

Result of running an Insert-Tables command

Insert a new worksheet into an Excel XLSX spreadsheet

Inserts a new worksheet into an Excel Spreadsheet

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Path
Path string

The Path of the location of this object; leave blank for new worksheets

WorksheetName
WorksheetName string

User-facing name of the worksheet tab

Returns

Result of running a Get-Worksheets command

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.

Parameters

Name Key Required Type Description
ImageContentsURL
ImageContentsURL string

URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents.

ImageDataContentType
ImageDataContentType string

Read-only; image data MIME content-type

ImageDataEmbedId
ImageDataEmbedId string

Read-only; internal ID for the image contents

ImageDescription
ImageDescription string

The Description of the image

ImageHeight
ImageHeight integer

Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

ImageId
ImageId integer

The Id of the image

ImageInternalFileName
ImageInternalFileName string

Read-only; internal file name/path for the image

ImageName
ImageName string

The Name of the image

ImageWidth
ImageWidth integer

Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

InlineWithText
InlineWithText boolean

True if the image is inline with the text; false if it is floating

Path
Path string

The Path of the location of this object; leave blank for new tables

XOffset
XOffset integer

X (horizontal) offset of the image

YOffset
YOffset integer

Y (vertical) offset of the image

InputDocumentFileBytes
InputDocumentFileBytes byte

Optional: Bytes of the input file to operate on

InputDocumentFileUrl
InputDocumentFileUrl string

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

InputImageFileBytes
InputImageFileBytes byte

Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd.

InputImageFileUrl
InputImageFileUrl string

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

InsertPath
InsertPath string

Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject

InsertPlacement
InsertPlacement string

Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)

Returns

Result of running a set-footer command

Merge Multple Excel XLSX Together

Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Parameters

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

First input file to perform the operation on.

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

Second input file to perform the operation on.

Third input file to perform the operation on.
inputFile3 file

Third input file to perform the operation on.

Fourth input file to perform the operation on.
inputFile4 file

Fourth input file to perform the operation on.

Fifth input file to perform the operation on.
inputFile5 file

Fifth input file to perform the operation on.

Sixth input file to perform the operation on.
inputFile6 file

Sixth input file to perform the operation on.

Seventh input file to perform the operation on.
inputFile7 file

Seventh input file to perform the operation on.

Eighth input file to perform the operation on.
inputFile8 file

Eighth input file to perform the operation on.

Ninth input file to perform the operation on.
inputFile9 file

Ninth input file to perform the operation on.

Tenth input file to perform the operation on.
inputFile10 file

Tenth input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Merge Multple PDF Files Together

Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Parameters

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

First input file to perform the operation on.

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

Second input file to perform the operation on.

Third input file to perform the operation on.
inputFile3 file

Third input file to perform the operation on.

Fourth input file to perform the operation on.
inputFile4 file

Fourth input file to perform the operation on.

Fifth input file to perform the operation on.
inputFile5 file

Fifth input file to perform the operation on.

Sixth input file to perform the operation on.
inputFile6 file

Sixth input file to perform the operation on.

Seventh input file to perform the operation on.
inputFile7 file

Seventh input file to perform the operation on.

Eighth input file to perform the operation on.
inputFile8 file

Eighth input file to perform the operation on.

Ninth input file to perform the operation on.
inputFile9 file

Ninth input file to perform the operation on.

Tenth input file to perform the operation on.
inputFile10 file

Tenth input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Merge Multple PNG Files Together

Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters

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

First input file to perform the operation on.

Second input file to perform the operation on (more than 2 can be supplied).
inputFile2 True file

Second input file to perform the operation on (more than 2 can be supplied).

Returns

Output file content from the operation

OutputContent
binary

Merge Multple PowerPoint PPTX Together

Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Parameters

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

First input file to perform the operation on.

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

Second input file to perform the operation on.

Third input file to perform the operation on.
inputFile3 file

Third input file to perform the operation on.

Fourth input file to perform the operation on.
inputFile4 file

Fourth input file to perform the operation on.

Fifth input file to perform the operation on.
inputFile5 file

Fifth input file to perform the operation on.

Sixth input file to perform the operation on.
inputFile6 file

Sixth input file to perform the operation on.

Seventh input file to perform the operation on.
inputFile7 file

Seventh input file to perform the operation on.

Eighth input file to perform the operation on.
inputFile8 file

Eighth input file to perform the operation on.

Ninth input file to perform the operation on.
inputFile9 file

Ninth input file to perform the operation on.

Tenth input file to perform the operation on.
inputFile10 file

Tenth input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Merge Multple Word DOCX Together

Combine multiple Office Word Documents (docx) into one single Office Word document

Parameters

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

First input file to perform the operation on.

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

Second input file to perform the operation on.

Third input file to perform the operation on.
inputFile3 file

Third input file to perform the operation on.

Fourth input file to perform the operation on.
inputFile4 file

Fourth input file to perform the operation on.

Fifth input file to perform the operation on.
inputFile5 file

Fifth input file to perform the operation on.

Sixth input file to perform the operation on.
inputFile6 file

Sixth input file to perform the operation on.

Seventh input file to perform the operation on.
inputFile7 file

Seventh input file to perform the operation on.

Eighth input file to perform the operation on.
inputFile8 file

Eighth input file to perform the operation on.

Ninth input file to perform the operation on.
inputFile9 file

Ninth input file to perform the operation on.

Tenth input file to perform the operation on.
inputFile10 file

Tenth input file to perform the operation on.

Returns

Output file content from the operation

OutputContent
binary

Merge Two Excel XLSX Together

Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Parameters

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

First input file to perform the operation on.

Second input file to perform the operation on (more than 2 can be supplied).
inputFile2 True file

Second input file to perform the operation on (more than 2 can be supplied).

Returns

Output file content from the operation

OutputContent
binary

Merge Two PDF Files Together

Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Parameters

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

First input file to perform the operation on.

Second input file to perform the operation on (more than 2 can be supplied).
inputFile2 True file

Second input file to perform the operation on (more than 2 can be supplied).

Returns

Output file content from the operation

OutputContent
binary

Merge Two PowerPoint PPTX Together

Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Parameters

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

First input file to perform the operation on.

Second input file to perform the operation on (more than 2 can be supplied).
inputFile2 True file

Second input file to perform the operation on (more than 2 can be supplied).

Returns

Output file content from the operation

OutputContent
binary

Merge Two Word DOCX Together

Combine two Office Word Documents (docx) into one single Office Word document

Parameters

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

First input file to perform the operation on.

Second input file to perform the operation on (more than 2 can be supplied).
inputFile2 True file

Second input file to perform the operation on (more than 2 can be supplied).

Returns

Output file content from the operation

OutputContent
binary

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).

Parameters

Name Key Required Type Description
Input file format as a 3+ letter file extension. You can also provide...
format1 True string

Input file format as a 3+ letter file extension. You can also provide...

Output (convert to this format) file format as a 3+ letter file extens...
format2 True string

Output (convert to this format) file format as a 3+ letter file extens...

Input file to perform the operation on.
inputFile True file

Input file to perform the operation on.

Returns

Result of converting a multi-page image into individual pages with a different format

Remove headers and footers from Word DOCX document

Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

RemoveFooters
RemoveFooters boolean

True if you would like to remove all footers from the input document, false otherwise

RemoveHeaders
RemoveHeaders boolean

True if you would like to remove all headers from the input document, false otherwise

Returns

Result of running a Remove Headers and Footers command

Replace string in PowerPoint PPTX presentation

Replace all instances of a string in an Office PowerPoint Document (pptx)

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

MatchCase
MatchCase boolean

True if the case should be matched, false for case insensitive match

MatchString
MatchString string

String to search for and match against, to be replaced

ReplaceString
ReplaceString string

String to replace the matched values with

Returns

Output file content from the operation

OutputContent
binary

Replace string in Word DOCX document

Replace all instances of a string in an Office Word Document (docx)

Parameters

Name Key Required Type Description
InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

MatchCase
MatchCase boolean

True if the case should be matched, false for case insensitive match

MatchString
MatchString string

String to search for and match against, to be replaced

ReplaceString
ReplaceString string

String to replace the matched values with

Returns

Output file content from the operation

OutputContent
binary

Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Parameters

Name Key Required Type Description
Bold
Bold boolean

True to make the text bold, false otherwise

FontFamily
FontFamily string

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize
FontSize string

Font size in font points (e.g. "24")

Italic
Italic boolean

True to make the text italic, false otherwise

Path
Path string

The Path of the location of this object; leave blank for new tables

RunIndex
RunIndex integer

Index of the run, 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

TextContent
TextContent string

Text string containing the text content of this text content item

TextIndex
TextIndex integer

Index of the text content in the run; 0-based

Underline
Underline string

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None

ParagraphIndex
ParagraphIndex integer

The index of the paragraph; 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

Style ID of the style applied to the paragraph; null if no style is applied

Path
Path string

The Path of the location of this object; leave blank for new tables

Path
Path string

The Path of the location of this object; leave blank for new tables

StartingPageNumbers
StartingPageNumbers integer

True to make the text bold, false otherwise

InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a set-footer command

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.

Parameters

Name Key Required Type Description
Bold
Bold boolean

True to make the text bold, false otherwise

FontFamily
FontFamily string

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize
FontSize string

Font size in font points (e.g. "24")

Italic
Italic boolean

True to make the text italic, false otherwise

Path
Path string

The Path of the location of this object; leave blank for new tables

RunIndex
RunIndex integer

Index of the run, 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

TextContent
TextContent string

Text string containing the text content of this text content item

TextIndex
TextIndex integer

Index of the text content in the run; 0-based

Underline
Underline string

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None

ParagraphIndex
ParagraphIndex integer

The index of the paragraph; 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

Style ID of the style applied to the paragraph; null if no style is applied

Path
Path string

The Path of the location of this object; leave blank for new tables

Path
Path string

The Path of the location of this object; leave blank for new tables

StartingPageNumbers
StartingPageNumbers integer

True to make the text bold, false otherwise

InputFileBytes
InputFileBytes byte

Optional: Bytes of the input file to operate on

InputFileUrl
InputFileUrl string

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

Returns

Result of running a set-header command

Split a PDF file into separate PDF files, one per page

Split an input PDF file into separate pages, comprised of one PDF file per page.

Parameters

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

Input file to perform the operation on.

Set to true to directly return all of the document contents in the Doc...
returnDocumentContents boolean

Set to true to directly return all of the document contents in the Doc...

Returns

Result of performing a PDF file split operation

Split a single Excel XLSX into Separate Worksheets

Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

Parameters

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

Input file to perform the operation on.

Returns

The result of splitting a spreadsheet into individual Excel XLSX worksheets

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.

Parameters

Name Key Required Type Description
ExtraLoadingWait
ExtraLoadingWait integer

Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds)

ScreenshotHeight
ScreenshotHeight integer

Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

ScreenshotWidth
ScreenshotWidth integer

Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

Url
Url string

URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports.

Returns

Output file content from the operation

OutputContent
binary

Validate a Excel document (XLSX)

Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Validate a JSON file

Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Validate a PDF document file

Validate a PDF document; if the document is not valid, identifies the errors in the document

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Validate a PowerPoint presentation (PPTX)

Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Validate a Word document (DOCX)

Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Validate an XML file

Validate an XML document file; if the document is not valid, identifies the errors in the document

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Validate if a file is executable

Validate if an input file is a binary executable file; if the document is not valid

Parameters

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

Input file to perform the operation on.

Returns

Document validation result

Definitions

AlternateFileFormatCandidate

Alternate file format possibility

Name Path Type Description
DetectedFileExtension
DetectedFileExtension string

Detected file extension of the file format, with a leading period

DetectedMimeType
DetectedMimeType string

MIME type of this file extension

Probability
Probability double

Probability that this extension is the right one; possible values are between 0.0 (lowest confidence) and 1.0 (highest confidence)

AutodetectDocumentValidationResult

Document validation result

Name Path Type Description
DocumentIsValid
DocumentIsValid boolean

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

ErrorCount
ErrorCount integer

Number of validation errors found in the document

ErrorsAndWarnings
ErrorsAndWarnings array of DocumentValidationError

Details of errors and warnings found

FileFormatExtension
FileFormatExtension string
WarningCount
WarningCount integer

Number of validation warnings found in the document

AutodetectGetInfoResult

Result of an autodetect/get-info operation

Name Path Type Description
AlternateFileTypeCandidates
AlternateFileTypeCandidates array of AlternateFileFormatCandidate

Alternate file type options and their probability

Author
Author string

User name of the creator/author of the document, if available, null if not available

DateModified
DateModified date-time

The timestamp that the document was last modified, if available, null if not available

DetectedFileExtension
DetectedFileExtension string

Detected file extension of the file format, with a leading period

DetectedMimeType
DetectedMimeType string

MIME type of this file extension

PageCount
PageCount integer

Number of pages in a page-based document; for presentations, this is the number of slides and for a spreadsheet this is the number of worksheets. Contains 0 when the page count cannot be determined, or if the concept of page count does not apply (e.g. for an image)

Successful
Successful boolean

True if the operation was successful, false otherwise

AutodetectToPngResult

Result of converting an autodetected input to a PNG array

Name Path Type Description
PngResultPages
PngResultPages array of ConvertedPngPage

Array of converted pages

Successful
Successful boolean

True if the operation was successful, false otherwise

ConvertedPngPage

A single converted page

Name Path Type Description
PageNumber
PageNumber integer

Page number of the converted page, starting with 1

URL
URL string

URL to the PNG file of this page; file is stored in an in-memory cache and will be deleted

DocumentValidationError

Validation error found in document

Name Path Type Description
Description
Description string

Description of the error

IsError
IsError boolean

True if this is an error, false otherwise

Path
Path string

XPath to the error

Uri
Uri string

URI of the part in question

DocumentValidationResult

Document validation result

Name Path Type Description
DocumentIsValid
DocumentIsValid boolean

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

ErrorCount
ErrorCount integer

Number of validation errors found in the document

ErrorsAndWarnings
ErrorsAndWarnings array of DocumentValidationError

Details of errors and warnings found

WarningCount
WarningCount integer

Number of validation warnings found in the document

DocxBody

Name Path Type Description
AllParagraphs
AllParagraphs array of DocxParagraph

All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document

AllTables
AllTables array of DocxTable

All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document

Path
Path string

The Path of the location of this object; leave blank for new tables

DocxCellStyle

Style in an Excel spreadsheet

Name Path Type Description
BuiltInID
BuiltInID integer

Built=in ID of the cell style

FormatID
FormatID integer

Format ID of the cell style

Name
Name string

Name of the style

Path
Path string

The Path of the location of this object; leave blank for new rows

DocxFooter

Footer in a Word Document (DOCX)

Name Path Type Description
Paragraphs
Paragraphs array of DocxParagraph

Paragraphs in this footer

Path
Path string

The Path of the location of this object; leave blank for new tables

SectionsWithFooter
SectionsWithFooter array of DocxSection

Sections that the footer is applied to

DocxHeader

Header of a Word Document (DOCX)

Name Path Type Description
Paragraphs
Paragraphs array of DocxParagraph

Paragraphs in this header

Path
Path string

The Path of the location of this object; leave blank for new tables

SectionsWithHeader
SectionsWithHeader array of DocxSection

Sections that the header is applied to

DocxImage

Name Path Type Description
ImageContentsURL
ImageContentsURL string

URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents.

ImageDataContentType
ImageDataContentType string

Read-only; image data MIME content-type

ImageDataEmbedId
ImageDataEmbedId string

Read-only; internal ID for the image contents

ImageDescription
ImageDescription string

The Description of the image

ImageHeight
ImageHeight integer

Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

ImageId
ImageId integer

The Id of the image

ImageInternalFileName
ImageInternalFileName string

Read-only; internal file name/path for the image

ImageName
ImageName string

The Name of the image

ImageWidth
ImageWidth integer

Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

InlineWithText
InlineWithText boolean

True if the image is inline with the text; false if it is floating

Path
Path string

The Path of the location of this object; leave blank for new tables

XOffset
XOffset integer

X (horizontal) offset of the image

YOffset
YOffset integer

Y (vertical) offset of the image

DocxInsertImageResponse

Result of running a set-footer command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

DocxPage

Name Path Type Description
PageNumber
PageNumber integer

Page number of this page, 1-based

Paragraphs
Paragraphs array of DocxParagraph

All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document

DocxParagraph

A paragraph in a Word Document (DOCX) file; there is where text, content and formatting are stored - similar to the paragraph tag in HTML

Name Path Type Description
ContentRuns
ContentRuns array of DocxRun

The content runs in the paragraph - this is where text is stored; similar to a span in HTML

ParagraphIndex
ParagraphIndex integer

The index of the paragraph; 0-based

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

Style ID of the style applied to the paragraph; null if no style is applied

DocxRemoveObjectResponse

Result of running an Remove-Object command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

DocxRun

A content run in a Word Document (DOCX) file

Name Path Type Description
Bold
Bold boolean

True to make the text bold, false otherwise

FontFamily
FontFamily string

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize
FontSize string

Font size in font points (e.g. "24")

Italic
Italic boolean

True to make the text italic, false otherwise

Path
Path string

The Path of the location of this object; leave blank for new tables

RunIndex
RunIndex integer

Index of the run, 0-based

TextItems
TextItems array of DocxText

Text items inside the run; this is where the actual text content is stored

Underline
Underline string

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None

DocxSection

Section of a Word Document (DOCX)

Name Path Type Description
Path
Path string

The Path of the location of this object; leave blank for new tables

StartingPageNumbers
StartingPageNumbers array of integer

Page numbers that the section starts at, typically just one

DocxSetFooterResponse

Result of running a set-footer command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

DocxSetHeaderResponse

Result of running a set-header command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

DocxStyle

Style in a DOCX Word Document

Name Path Type Description
Bold
Bold boolean

Style applies bold formatting

FontFamily
FontFamily string

Font family

FontSize
FontSize string

Font size

Italic
Italic boolean

Style applies italic formatting

Path
Path string

The Path of the location of this object; leave blank for new tables

StyleID
StyleID string

ID of the style

Underline
Underline boolean

Style applies underline formatting

DocxTable

A table in a Word Document (DOCX) file

Name Path Type Description
BottomBorderColor
BottomBorderColor string

HTML-style color hex value (do not include a #)

BottomBorderSize
BottomBorderSize integer

Width of the border in points (1/72nd of an inch)

BottomBorderSpace
BottomBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

BottomBorderType
BottomBorderType string

Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

CellHorizontalBorderColor
CellHorizontalBorderColor string

HTML-style color hex value (do not include a #)

CellHorizontalBorderSize
CellHorizontalBorderSize integer

Width of the border in points (1/72nd of an inch)

CellHorizontalBorderSpace
CellHorizontalBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

CellHorizontalBorderType
CellHorizontalBorderType string

Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

CellVerticalBorderColor
CellVerticalBorderColor string

HTML-style color hex value (do not include a #)

CellVerticalBorderSize
CellVerticalBorderSize integer

Width of the border in points (1/72nd of an inch)

CellVerticalBorderSpace
CellVerticalBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

CellVerticalBorderType
CellVerticalBorderType string

Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

EndBorderColor
EndBorderColor string

HTML-style color hex value (do not include a #)

EndBorderSize
EndBorderSize integer

Width of the border in points (1/72nd of an inch)

EndBorderSpace
EndBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

EndBorderType
EndBorderType string

Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

LeftBorderColor
LeftBorderColor string

HTML-style color hex value (do not include a #)

LeftBorderSize
LeftBorderSize integer

Width of the border in points (1/72nd of an inch)

LeftBorderSpace
LeftBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

LeftBorderType
LeftBorderType string

Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

Path
Path string

The Path of the location of this object; leave blank for new tables

RightBorderColor
RightBorderColor string

HTML-style color hex value (do not include a #)

RightBorderSize
RightBorderSize integer

Width of the border in points (1/72nd of an inch)

RightBorderSpace
RightBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

RightBorderType
RightBorderType string

Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

StartBorderColor
StartBorderColor string

HTML-style color hex value (do not include a #)

StartBorderSize
StartBorderSize integer

Width of the border in points (1/72nd of an inch)

StartBorderSpace
StartBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

StartBorderType
StartBorderType string

Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

TableID
TableID string

The ID of the table; leave blank for new tables

TableIndentationMode
TableIndentationMode string

Table indentation type

TableIndentationWidth
TableIndentationWidth integer

Table indentation width

TableRows
TableRows array of DocxTableRow

Rows in the table; this is where the contents is located

TopBorderColor
TopBorderColor string

HTML-style color hex value (do not include a #)

TopBorderSize
TopBorderSize integer

Width of the border in points (1/72nd of an inch)

TopBorderSpace
TopBorderSpace integer

Spacing around the border in points (1/72nd of an inch)

TopBorderType
TopBorderType string

Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

Width
Width string

The Width of the table, or 0 if not specified

WidthType
WidthType string

The Width configuration type of the table

DocxTableCell

A cell in a Word Document (DOCX) file

Name Path Type Description
CellIndex
CellIndex integer

The index of the cell, 0-based

CellShadingColor
CellShadingColor string

Color of the cell shading

CellShadingFill
CellShadingFill string

Fill of the cell shading

CellShadingPattern
CellShadingPattern string

Pattern of the cell shading

CellWidth
CellWidth string

Width of the cell

CellWidthMode
CellWidthMode string

Width mode of the cell; can be auto (for automatic) or manual

Paragraphs
Paragraphs array of DocxParagraph

Paragraphs inside the cell; this is where the contents of the cell are stored

Path
Path string

The Path of the location of this object; leave blank for new tables

DocxTableRow

A row in a Word Document (DOCX) file

Name Path Type Description
Path
Path string

The Path of the location of this object; leave blank for new tables

RowCells
RowCells array of DocxTableCell

Cells in the row; this is where the contents of the row is stored

RowIndex
RowIndex integer

Index of the row, 0-based

DocxText

Unit of text content in a Word Document (DOCX) file

Name Path Type Description
Path
Path string

The Path of the location of this object; leave blank for new tables

TextContent
TextContent string

Text string containing the text content of this text content item

TextIndex
TextIndex integer

Index of the text content in the run; 0-based

ExifValue

EXIF tag and value

Name Path Type Description
DataType
DataType string

Date type of the EXIF value

DataValue
DataValue string

Value, formatted as a string of the EXIF value

Tag
Tag string

Tag name for the EXIF value

GetDocxBodyResponse

Result of running a Get-Body command

Name Path Type Description
Body
Body DocxBody
Successful
Successful boolean

True if successful, false otherwise

GetDocxHeadersAndFootersResponse

Result of running a Get-Tables command

Name Path Type Description
Footers
Footers array of DocxFooter
Headers
Headers array of DocxHeader
Successful
Successful boolean

True if successful, false otherwise

GetDocxImagesResponse

Result of running a Get-Images command

Name Path Type Description
Images
Images array of DocxImage

Images in the DOCX document

Successful
Successful boolean

True if successful, false otherwise

GetDocxPagesResponse

Name Path Type Description
PageCount
PageCount integer
Pages
Pages array of DocxPage
Successful
Successful boolean

GetDocxSectionsResponse

Result of running a Get-Sections command

Name Path Type Description
Sections
Sections array of DocxSection

Sections in the DOCX document

Successful
Successful boolean

True if successful, false otherwise

GetDocxStylesResponse

Result of running a Get-Tables command

Name Path Type Description
Styles
Styles array of DocxStyle

Styles in the DOCX document

Successful
Successful boolean

True if successful, false otherwise

GetDocxTablesResponse

Result of running a Get-Tables command

Name Path Type Description
Successful
Successful boolean

True if successful, false otherwise

Tables
Tables array of DocxTable

Tables in the DOCX file

GetImageInfoResult

Result of running a get-info operation on an image

Name Path Type Description
BitDepth
BitDepth integer

Bit depth of the image

ColorCount
ColorCount integer

Unique colors in the image

ColorSpace
ColorSpace string

Color space of the image

ColorType
ColorType string

Color type of the image

Comment
Comment string

Comment string in the image

CompressionLevel
CompressionLevel integer

Compression level value from 0 (lowest quality) to 100 (highest quality)

DPI
DPI double

DPI (pixels per unit, e.g. pixels per inch) of the image

DPIUnit
DPIUnit string

Units of the DPI measurement; can be either in Inches or Centimeters

ExifProfileName
ExifProfileName string

Name of the EXIF profile used

ExifValues
ExifValues array of ExifValue

EXIF tags and values embedded in the image

HasTransparency
HasTransparency boolean

True if the image contains transparency, otherwise false

Height
Height integer

Height in pixels of the image

ImageFormat
ImageFormat string

Image format

ImageHashSignature
ImageHashSignature string

SHA256 hash signature of the image

MimeType
MimeType string

MIME type of the image format

Successful
Successful boolean
Width
Width integer

Width in pixels of the image

GetXlsxColumnsResponse

Result of running a Get-Columns command

Name Path Type Description
Columns
Columns array of XlsxSpreadsheetColumn

Spreadsheet Columns in the DOCX document

Successful
Successful boolean

True if successful, false otherwise

GetXlsxImagesResponse

Result of running a Get-Images command

Name Path Type Description
Images
Images array of XlsxImage

Spreadsheet Columns in the DOCX document

Successful
Successful boolean

True if successful, false otherwise

GetXlsxRowsAndCellsResponse

Result of running a Get-Worksheets command

Name Path Type Description
Rows
Rows array of XlsxSpreadsheetRow

Spreadsheet Rows in the DOCX document

Successful
Successful boolean

True if successful, false otherwise

GetXlsxStylesResponse

Result of running a Get-Worksheets command

Name Path Type Description
CellStyles
CellStyles array of DocxCellStyle

Cell styles

Successful
Successful boolean

True if successful, false otherwise

GetXlsxWorksheetsResponse

Result of running a Get-Worksheets command

Name Path Type Description
Successful
Successful boolean

True if successful, false otherwise

Worksheets
Worksheets array of XlsxWorksheet

Styles in the DOCX document

HtmlMdResult

Result from converting a Markdown file to HTML

Name Path Type Description
Html
Html string

Resulting HTML from the conversion

Successful
Successful boolean

True if operation was successful, false otherwise

HtmlTemplateApplicationResponse

Response from an HTML template application

Name Path Type Description
FinalHtml
FinalHtml string

Final HTML result of all operations on input

Successful
Successful boolean

True if the operation was successful, false otherwise

InsertDocxInsertParagraphResponse

Result of running an Insert-Paragraph command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

InsertDocxTableRowResponse

Result of running an Insert-Table Row command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

InsertDocxTablesResponse

Result of running an Insert-Tables command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

InsertXlsxWorksheetResponse

Result of running a Get-Worksheets command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

MultipageImageFormatConversionResult

Result of converting a multi-page image into individual pages with a different format

Name Path Type Description
PageCount
PageCount integer

The number of pages in the converted output

Pages
Pages array of PageConversionResult

Converted page results

Successful
Successful boolean

True if successful, false otherwise

PageConversionResult

Converted page as an image

Name Path Type Description
FileBytes
FileBytes byte

File bytes (contents) of the image in converted file format

Filename
Filename string

File name of the image in the converted file format

PdfDocument

A single PDF file corresponding to one page in the original document

Name Path Type Description
DocumentContents
DocumentContents byte

If returnDocumentContents is set to true, will contain the contents of the document; otherwise will be set to null and the document contents will be available via the URL parameter

PageNumber
PageNumber integer

Page number of the converted page, starting with 1 for the first page

URL
URL string

URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted

PdfToPngResult

Result of converting a PDF to a PNG array

Name Path Type Description
PngResultPages
PngResultPages array of ConvertedPngPage

Array of converted pages

Successful
Successful boolean

True if the operation was successful, false otherwise

RemoveDocxHeadersAndFootersResponse

Result of running a Remove Headers and Footers command

Name Path Type Description
EditedDocumentURL
EditedDocumentURL string

URL of the resulting edited document; this is a secure URL and cannot be downloaded without adding the Apikey header; it is also temporary, stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents.

Successful
Successful boolean

True if successful, false otherwise

SplitPdfResult

Result of performing a PDF file split operation

Name Path Type Description
Documents
Documents array of PdfDocument

PDF documents as output

Successful
Successful boolean

True if the operation was successful, false otherwise

SplitXlsxWorksheetResult

The result of splitting a spreadsheet into individual Excel XLSX worksheets

Name Path Type Description
ResultWorksheets
ResultWorksheets array of WorksheetResult
Successful
Successful boolean

True if the operation was successful, false otherwise

TextConversionResult

Text conversion result from converting a document to Plain Text (TXT) format

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

TextResult
TextResult string

Plain Text (TXT) format conversion result of the input document. The text result is returned as a string.

ViewerResponse

Result of creating a viewer

Name Path Type Description
HtmlEmbed
HtmlEmbed string
Successful
Successful boolean

WorksheetResult

A single Excel XLSX file corresponding to one worksheet (tab) in the original spreadsheet

Name Path Type Description
URL
URL string

URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted

WorksheetName
WorksheetName string

The name of the worksheet

WorksheetNumber
WorksheetNumber integer

Worksheet number of the converted page, starting with 1 for the left-most worksheet

XlsxImage

Name Path Type Description
ImageContentsURL
ImageContentsURL string

URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents.

ImageDataContentType
ImageDataContentType string

Read-only; image data MIME content-type

ImageDataEmbedId
ImageDataEmbedId string

Read-only; internal ID for the image contents

ImageInternalFileName
ImageInternalFileName string

Read-only; internal file name/path for the image

Path
Path string

The Path of the location of this object; leave blank for new rows

XlsxSpreadsheetCell

Cell in an Excel Spreadsheet worksheet

Name Path Type Description
CellIdentifier
CellIdentifier string

Cell reference of the cell, e.g. A1, Z22, etc.

Formula
Formula string
Path
Path string

The Path of the location of this object; leave blank for new rows

StyleIndex
StyleIndex integer

Identifier for the style to apply to this style

TextValue
TextValue string

Text value of the cell

XlsxSpreadsheetColumn

Column in an Excel spreadsheet worksheet

Name Path Type Description
HeadingCell
HeadingCell XlsxSpreadsheetCell

Cell in an Excel Spreadsheet worksheet

Path
Path string

The Path of the location of this object; leave blank for new rows

XlsxSpreadsheetRow

Row in an Excel spreadsheet worksheet

Name Path Type Description
Cells
Cells array of XlsxSpreadsheetCell

Spreadsheet Cells in the spreadsheet row

Path
Path string

The Path of the location of this object; leave blank for new rows

XlsxWorksheet

A worksheet (tab) in an Excel (XLSX) spreadsheet

Name Path Type Description
Path
Path string

The Path of the location of this object; leave blank for new worksheets

WorksheetName
WorksheetName string

User-facing name of the worksheet tab