convertapi API Reference

Convert API lets you effortlessly convert file formats and types.

Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client

API Endpoint
https://api.cloudmersive.com
Schemes: https
Version: v1

Authentication

Apikey

API Key Authentication

type
apiKey
name
Apikey
in
header

CompareDocument

Compare Two Word DOCX

POST /convert/compare/docx


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



inputFile1: file
in formData

First input file to perform the operation on.

inputFile2: file
in formData

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

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

ConvertData

CSV to JSON conversion

POST /convert/csv/to/json


Convert a CSV file to a JSON object array



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
object
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"object"

XML to JSON conversion

POST /convert/xml/to/json


Convert an XML string or file into JSON



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
object
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"object"

ConvertDocument

Word DOCX to PDF

POST /convert/docx/to/pdf


Convert Office Word Documents (docx) to standard PDF



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Word DOC (97-03) to PDF

POST /convert/doc/to/pdf


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Word DOC (97-03) to DOCX

POST /convert/doc/to/docx


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

PowerPoint PPTX to PDF

POST /convert/pptx/to/pdf


Convert Office PowerPoint Documents (pptx) to standard PDF



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

PowerPoint PPT (97-03) to PDF

POST /convert/ppt/to/pdf


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

PowerPoint PPT (97-03) to PPTX

POST /convert/ppt/to/pptx


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Excel XLSX to PDF

POST /convert/xlsx/to/pdf


Convert Office Excel Workbooks (xlsx) to standard PDF. Converts all worksheets in the workbook to PDF.



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Excel XLS (97-03) to PDF

POST /convert/xls/to/pdf


Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
object
Response Content-Types: application/octet-stream
Response Example (200 OK)
"object"

Excel XLS (97-03) to XLSX

POST /convert/xls/to/xlsx


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

CSV to Excel XLSX

POST /convert/csv/to/xlsx


Convert CSV file to Office Excel XLSX Workbooks file format.



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Excel XLSX to CSV

POST /convert/xlsx/to/csv


Convert Office Excel Workbooks (xlsx) to standard Comma-Separated Values (CSV) format.



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Get document type information

POST /convert/autodetect/get-info


Auto-detects a document's type information; does not require file extension. Analyzes file contents to confirm file type.



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "DetectedFileExtension": "string",
  "DetectedMimeType": "string",
  "AlternateFileTypeCandidates": [
    {
      "Probability": "number (double)",
      "DetectedFileExtension": "string",
      "DetectedMimeType": "string"
    }
  ]
}

Convert Document to PDF

POST /convert/autodetect/to/pdf


Automatically detect file type and convert it to PDF.



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

PDF to PNG Array

POST /convert/pdf/to/png


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:

OK

Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "PngResultPages": [
    {
      "PageNumber": "integer (int32)",
      "URL": "string"
    }
  ]
}

ConvertImage

Image format conversion

POST /convert/image/{format1}/to/{format2}


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



format1: string
in path

Input file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV

format2: string
in path

Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV

inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"

Change image DPI

POST /convert/image/set-dpi/{dpi}


Resize an image to have a different DPI



dpi: integer (int32)
in path

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

inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"

Get information about an image

POST /convert/image/get-info


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "ColorSpace": "string",
  "ColorType": "string",
  "Width": "integer (int32)",
  "Height": "integer (int32)",
  "CompressionLevel": "integer (int32)",
  "ImageHashSignature": "string",
  "HasTransparency": "boolean",
  "MimeType": "string",
  "ImageFormat": "string",
  "DPIUnit": "string",
  "DPI": "number (double)",
  "ColorCount": "integer (int32)",
  "BitDepth": "integer (int32)",
  "Comment": "string",
  "ExifProfileName": "string",
  "ExifValues": [
    {
      "Tag": "string",
      "DataType": "string",
      "DataValue": "string"
    }
  ]
}

ConvertTemplate

Apply HTML template

POST /convert/template/html/apply


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



Operations to apply to template

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "HtmlTemplate": "string",
  "HtmlTemplateUrl": "string",
  "Operations": [
    {
      "Action": "integer (int32)",
      "MatchAgsint": "string",
      "ReplaceWith": "string"
    }
  ]
}
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "FinalHtml": "string"
}

ConvertWeb

Take screenshot of URL

POST /convert/web/url/to/screenshot


Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.



Screenshot request parameters

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "Url": "string",
  "ExtraLoadingWait": "integer (int32)"
}
200 OK

OK

type
string (byte)
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"

Convert a URL to PDF

POST /convert/web/url/to/pdf


Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.



URL to PDF request parameters

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "Url": "string",
  "ExtraLoadingWait": "integer (int32)"
}
200 OK

OK

type
string (byte)
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string (byte)"

Convert HTML string to PDF

POST /convert/web/html/to/pdf


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



HTML to PDF request parameters

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "Html": "string",
  "ExtraLoadingWait": "integer (int32)"
}
200 OK

OK

type
object
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"object"

HTML to DOCX

POST /convert/html/to/docx


Convert HTML to Office Word Document (DOCX) format



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "Html": "string"
}
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Convert Markdown to HTML

POST /convert/web/md/to/html


Convert a markdown file (.md) to HTML



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Html": "string"
}

EditDocument

Begin editing a document

POST /convert/edit/begin-editing


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
200 OK

OK

type
string
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string"

Download result from document editing

POST /convert/edit/finish-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.



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileUrl": "string"
}
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Replace string in DOCX

POST /convert/edit/docx/replace-all


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "MatchString": "string",
  "ReplaceString": "string",
  "MatchCase": "boolean"
}
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Replace string in PPTX

POST /convert/edit/pptx/replace-all


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "MatchString": "string",
  "ReplaceString": "string",
  "MatchCase": "boolean"
}
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Get tables in DOCX

POST /convert/edit/docx/get-tables


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Tables": [
    {
      "TableID": "string",
      "Path": "string",
      "Width": "string",
      "WidthType": "string",
      "TableRows": [
        {
          "RowIndex": "integer (int32)",
          "Path": "string",
          "RowCells": [
            {
              "CellIndex": "integer (int32)",
              "Path": "string",
              "Paragraphs": [
                {
                  "ParagraphIndex": "integer (int32)",
                  "Path": "string",
                  "ContentRuns": [
                    {
                      "RunIndex": "integer (int32)",
                      "Path": "string",
                      "TextItems": [
                        {
                          "TextIndex": "integer (int32)",
                          "Path": "string",
                          "TextContent": "string"
                        }
                      ],
                      "Bold": "boolean",
                      "Italic": "boolean",
                      "Underline": "string",
                      "FontFamily": "string",
                      "FontSize": "string"
                    }
                  ],
                  "StyleID": "string"
                }
              ],
              "CellShadingColor": "string",
              "CellShadingFill": "string",
              "CellShadingPattern": "string",
              "CellWidthMode": "string",
              "CellWidth": "string"
            }
          ]
        }
      ],
      "TopBorderType": "string",
      "TopBorderSize": "integer (int32)",
      "TopBorderSpace": "integer (int32)",
      "TopBorderColor": "string",
      "BottomBorderType": "string",
      "BottomBorderSize": "integer (int32)",
      "BottomBorderSpace": "integer (int32)",
      "BottomBorderColor": "string",
      "LeftBorderType": "string",
      "LeftBorderSize": "integer (int32)",
      "LeftBorderSpace": "integer (int32)",
      "LeftBorderColor": "string",
      "RightBorderType": "string",
      "RightBorderSize": "integer (int32)",
      "RightBorderSpace": "integer (int32)",
      "RightBorderColor": "string",
      "CellHorizontalBorderType": "string",
      "CellHorizontalBorderSize": "integer (int32)",
      "CellHorizontalBorderSpace": "integer (int32)",
      "CellHorizontalBorderColor": "string",
      "CellVerticalBorderType": "string",
      "CellVerticalBorderSize": "integer (int32)",
      "CellVerticalBorderSpace": "integer (int32)",
      "CellVerticalBorderColor": "string",
      "StartBorderType": "string",
      "StartBorderSize": "integer (int32)",
      "StartBorderSpace": "integer (int32)",
      "StartBorderColor": "string",
      "EndBorderType": "string",
      "EndBorderSize": "integer (int32)",
      "EndBorderSpace": "integer (int32)",
      "EndBorderColor": "string",
      "TableIndentationMode": "string",
      "TableIndentationWidth": "integer (int32)"
    }
  ]
}

Get images from a DOCX

POST /convert/edit/docx/get-images


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Images": [
    {
      "Path": "string",
      "ImageName": "string",
      "ImageId": "integer (int64)",
      "ImageDescription": "string",
      "ImageWidth": "integer (int64)",
      "ImageHeight": "integer (int64)",
      "XOffset": "integer (int64)",
      "YOffset": "integer (int64)",
      "ImageDataEmbedId": "string",
      "ImageDataContentType": "string",
      "ImageInternalFileName": "string",
      "ImageContentsURL": "string",
      "InlineWithText": "boolean"
    }
  ]
}

Get styles from a DOCX

POST /convert/edit/docx/get-styles


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Styles": [
    {
      "StyleID": "string",
      "Path": "string",
      "Bold": "boolean",
      "Italic": "boolean",
      "Underline": "boolean",
      "FontSize": "string",
      "FontFamily": "string"
    }
  ]
}

Get sections from a DOCX

POST /convert/edit/docx/get-sections


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Sections": [
    {
      "StartingPageNumbers": [
        "integer (int32)"
      ],
      "Path": "string"
    }
  ]
}

Get body from a DOCX

POST /convert/edit/docx/get-body


Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document



undefined

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Body": {
    "Path": "string",
    "AllParagraphs": [
      {
        "ParagraphIndex": "integer (int32)",
        "Path": "string",
        "ContentRuns": [
          {
            "RunIndex": "integer (int32)",
            "Path": "string",
            "TextItems": [
              {
                "TextIndex": "integer (int32)",
                "Path": "string",
                "TextContent": "string"
              }
            ],
            "Bold": "boolean",
            "Italic": "boolean",
            "Underline": "string",
            "FontFamily": "string",
            "FontSize": "string"
          }
        ],
        "StyleID": "string"
      }
    ],
    "AllTables": [
      {
        "TableID": "string",
        "Path": "string",
        "Width": "string",
        "WidthType": "string",
        "TableRows": [
          {
            "RowIndex": "integer (int32)",
            "Path": "string",
            "RowCells": [
              {
                "CellIndex": "integer (int32)",
                "Path": "string",
                "Paragraphs": [
                  {
                    "ParagraphIndex": "integer (int32)",
                    "Path": "string",
                    "ContentRuns": [
                      {
                        "RunIndex": "integer (int32)",
                        "Path": "string",
                        "TextItems": [
                          {
                            "TextIndex": "integer (int32)",
                            "Path": "string",
                            "TextContent": "string"
                          }
                        ],
                        "Bold": "boolean",
                        "Italic": "boolean",
                        "Underline": "string",
                        "FontFamily": "string",
                        "FontSize": "string"
                      }
                    ],
                    "StyleID": "string"
                  }
                ],
                "CellShadingColor": "string",
                "CellShadingFill": "string",
                "CellShadingPattern": "string",
                "CellWidthMode": "string",
                "CellWidth": "string"
              }
            ]
          }
        ],
        "TopBorderType": "string",
        "TopBorderSize": "integer (int32)",
        "TopBorderSpace": "integer (int32)",
        "TopBorderColor": "string",
        "BottomBorderType": "string",
        "BottomBorderSize": "integer (int32)",
        "BottomBorderSpace": "integer (int32)",
        "BottomBorderColor": "string",
        "LeftBorderType": "string",
        "LeftBorderSize": "integer (int32)",
        "LeftBorderSpace": "integer (int32)",
        "LeftBorderColor": "string",
        "RightBorderType": "string",
        "RightBorderSize": "integer (int32)",
        "RightBorderSpace": "integer (int32)",
        "RightBorderColor": "string",
        "CellHorizontalBorderType": "string",
        "CellHorizontalBorderSize": "integer (int32)",
        "CellHorizontalBorderSpace": "integer (int32)",
        "CellHorizontalBorderColor": "string",
        "CellVerticalBorderType": "string",
        "CellVerticalBorderSize": "integer (int32)",
        "CellVerticalBorderSpace": "integer (int32)",
        "CellVerticalBorderColor": "string",
        "StartBorderType": "string",
        "StartBorderSize": "integer (int32)",
        "StartBorderSpace": "integer (int32)",
        "StartBorderColor": "string"
      }
    ]
  }
}

Get content of a footer from a DOCX

POST /convert/edit/docx/get-headers-and-footers


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Headers": [
    {
      "Path": "string",
      "Paragraphs": [
        {
          "ParagraphIndex": "integer (int32)",
          "Path": "string",
          "ContentRuns": [
            {
              "RunIndex": "integer (int32)",
              "Path": "string",
              "TextItems": [
                {
                  "TextIndex": "integer (int32)",
                  "Path": "string",
                  "TextContent": "string"
                }
              ],
              "Bold": "boolean",
              "Italic": "boolean",
              "Underline": "string",
              "FontFamily": "string",
              "FontSize": "string"
            }
          ],
          "StyleID": "string"
        }
      ],
      "SectionsWithHeader": [
        {
          "StartingPageNumbers": [
            "integer (int32)"
          ],
          "Path": "string"
        }
      ]
    }
  ],
  "Footers": [
    {
      "Path": "string",
      "Paragraphs": [
        {
          "ParagraphIndex": "integer (int32)",
          "Path": "string",
          "ContentRuns": [
            {
              "RunIndex": "integer (int32)",
              "Path": "string",
              "TextItems": [
                {
                  "TextIndex": "integer (int32)",
                  "Path": "string",
                  "TextContent": "string"
                }
              ],
              "Bold": "boolean",
              "Italic": "boolean",
              "Underline": "string",
              "FontFamily": "string",
              "FontSize": "string"
            }
          ],
          "StyleID": "string"
        }
      ],
      "SectionsWithFooter": [
        {
          "StartingPageNumbers": [
            "integer (int32)"
          ],
          "Path": "string"
        }
      ]
    }
  ]
}

Set the header in a DOCX

POST /convert/edit/docx/set-header


Set the header in a Word Document (DOCX)



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "HeaderToApply": {
    "Path": "string",
    "Paragraphs": [
      {
        "ParagraphIndex": "integer (int32)",
        "Path": "string",
        "ContentRuns": [
          {
            "RunIndex": "integer (int32)",
            "Path": "string",
            "TextItems": [
              {
                "TextIndex": "integer (int32)",
                "Path": "string",
                "TextContent": "string"
              }
            ],
            "Bold": "boolean",
            "Italic": "boolean",
            "Underline": "string",
            "FontFamily": "string",
            "FontSize": "string"
          }
        ],
        "StyleID": "string"
      }
    ],
    "SectionsWithHeader": [
      {
        "StartingPageNumbers": [
          "integer (int32)"
        ],
        "Path": "string"
      }
    ]
  }
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Set the footer in a DOCX

POST /convert/edit/docx/set-footer


Set the footer in a Word Document (DOCX)



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "FooterToApply": {
    "Path": "string",
    "Paragraphs": [
      {
        "ParagraphIndex": "integer (int32)",
        "Path": "string",
        "ContentRuns": [
          {
            "RunIndex": "integer (int32)",
            "Path": "string",
            "TextItems": [
              {
                "TextIndex": "integer (int32)",
                "Path": "string",
                "TextContent": "string"
              }
            ],
            "Bold": "boolean",
            "Italic": "boolean",
            "Underline": "string",
            "FontFamily": "string",
            "FontSize": "string"
          }
        ],
        "StyleID": "string"
      }
    ],
    "SectionsWithFooter": [
      {
        "StartingPageNumbers": [
          "integer (int32)"
        ],
        "Path": "string"
      }
    ]
  }
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Insert image into a DOCX

POST /convert/edit/docx/insert-image


Set the footer in a Word Document (DOCX)



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputDocumentFileBytes": "string (byte)",
  "InputDocumentFileUrl": "string",
  "InputImageFileBytes": "string (byte)",
  "InputImageFileUrl": "string",
  "ImageToAdd": {
    "Path": "string",
    "ImageName": "string",
    "ImageId": "integer (int64)",
    "ImageDescription": "string",
    "ImageWidth": "integer (int64)",
    "ImageHeight": "integer (int64)",
    "XOffset": "integer (int64)",
    "YOffset": "integer (int64)",
    "ImageDataEmbedId": "string",
    "ImageDataContentType": "string",
    "ImageInternalFileName": "string",
    "ImageContentsURL": "string",
    "InlineWithText": "boolean"
  },
  "InsertPlacement": "string",
  "InsertPath": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Insert a new paragraph into a DOCX

POST /convert/edit/docx/insert-paragraph


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "ParagraphToInsert": {
    "ParagraphIndex": "integer (int32)",
    "Path": "string",
    "ContentRuns": [
      {
        "RunIndex": "integer (int32)",
        "Path": "string",
        "TextItems": [
          {
            "TextIndex": "integer (int32)",
            "Path": "string",
            "TextContent": "string"
          }
        ],
        "Bold": "boolean",
        "Italic": "boolean",
        "Underline": "string",
        "FontFamily": "string",
        "FontSize": "string"
      }
    ],
    "StyleID": "string"
  },
  "InsertPlacement": "string",
  "InsertPath": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Insert a new table into a DOCX

POST /convert/edit/docx/insert-table


Adds a new table into a DOCX and returns the result



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "TableToInsert": {
    "TableID": "string",
    "Path": "string",
    "Width": "string",
    "WidthType": "string",
    "TableRows": [
      {
        "RowIndex": "integer (int32)",
        "Path": "string",
        "RowCells": [
          {
            "CellIndex": "integer (int32)",
            "Path": "string",
            "Paragraphs": [
              {
                "ParagraphIndex": "integer (int32)",
                "Path": "string",
                "ContentRuns": [
                  {
                    "RunIndex": "integer (int32)",
                    "Path": "string",
                    "TextItems": [
                      {
                        "TextIndex": "integer (int32)",
                        "Path": "string",
                        "TextContent": "string"
                      }
                    ],
                    "Bold": "boolean",
                    "Italic": "boolean",
                    "Underline": "string",
                    "FontFamily": "string",
                    "FontSize": "string"
                  }
                ],
                "StyleID": "string"
              }
            ],
            "CellShadingColor": "string",
            "CellShadingFill": "string",
            "CellShadingPattern": "string",
            "CellWidthMode": "string",
            "CellWidth": "string"
          }
        ]
      }
    ],
    "TopBorderType": "string",
    "TopBorderSize": "integer (int32)",
    "TopBorderSpace": "integer (int32)",
    "TopBorderColor": "string",
    "BottomBorderType": "string",
    "BottomBorderSize": "integer (int32)",
    "BottomBorderSpace": "integer (int32)",
    "BottomBorderColor": "string",
    "LeftBorderType": "string",
    "LeftBorderSize": "integer (int32)",
    "LeftBorderSpace": "integer (int32)",
    "LeftBorderColor": "string",
    "RightBorderType": "string",
    "RightBorderSize": "integer (int32)",
    "RightBorderSpace": "integer (int32)",
    "RightBorderColor": "string",
    "CellHorizontalBorderType": "string",
    "CellHorizontalBorderSize": "integer (int32)",
    "CellHorizontalBorderSpace": "integer (int32)",
    "CellHorizontalBorderColor": "string",
    "CellVerticalBorderType": "string",
    "CellVerticalBorderSize": "integer (int32)",
    "CellVerticalBorderSpace": "integer (int32)",
    "CellVerticalBorderColor": "string",
    "StartBorderType": "string",
    "StartBorderSize": "integer (int32)",
    "StartBorderSpace": "integer (int32)",
    "StartBorderColor": "string",
    "EndBorderType": "string",
    "EndBorderSize": "integer (int32)",
    "EndBorderSpace": "integer (int32)",
    "EndBorderColor": "string",
    "TableIndentationMode": "string",
    "TableIndentationWidth": "integer (int32)"
  },
  "InsertPlacement": "string",
  "InsertPath": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Remove headers and footers from DOCX

POST /convert/edit/docx/remove-headers-and-footers


Remove all headers, or footers, or both from a Word Document (DOCX)



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "RemoveHeaders": "boolean",
  "RemoveFooters": "boolean"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Delete any object in a DOCX

POST /convert/edit/docx/remove-object


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.



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "PathToObjectToRemove": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

Get worksheets from a XLSX

POST /convert/edit/xlsx/get-worksheets


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



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Worksheets": [
    {
      "Path": "string",
      "WorksheetName": "string"
    }
  ]
}

Get rows and cells from a XLSX worksheet

POST /convert/edit/xlsx/get-rows-and-cells


Returns the rows and cells defined in the Excel Spreadsheet worksheet



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToQuery": {
    "Path": "string",
    "WorksheetName": "string"
  }
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Rows": [
    {
      "Path": "string",
      "Cells": [
        {
          "Path": "string",
          "TextValue": "string",
          "CellIdentifier": "string",
          "StyleIndex": "integer (int32)",
          "Formula": "string"
        }
      ]
    }
  ]
}

Get rows and cells from a XLSX worksheet

POST /convert/edit/xlsx/get-columns


Returns the rows and cells defined in the Excel Spreadsheet worksheet



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToQuery": {
    "Path": "string",
    "WorksheetName": "string"
  }
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Columns": [
    {
      "Path": "string",
      "HeadingCell": {
        "Path": "string",
        "TextValue": "string",
        "CellIdentifier": "string",
        "StyleIndex": "integer (int32)",
        "Formula": "string"
      }
    }
  ]
}

Get images from a XLSX worksheet

POST /convert/edit/xlsx/get-images


Returns the images defined in the Excel Spreadsheet worksheet



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToQuery": {
    "Path": "string",
    "WorksheetName": "string"
  }
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "Images": [
    {
      "Path": "string",
      "ImageDataEmbedId": "string",
      "ImageDataContentType": "string",
      "ImageInternalFileName": "string",
      "ImageContentsURL": "string"
    }
  ]
}

Get styles from a XLSX worksheet

POST /convert/edit/xlsx/get-styles


Returns the style defined in the Excel Spreadsheet



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "CellStyles": [
    {
      "Path": "string",
      "Name": "string",
      "FormatID": "integer (int32)",
      "BuiltInID": "integer (int32)"
    }
  ]
}

Insert a new worksheet into an XLSX spreadsheet

POST /convert/edit/xlsx/insert-worksheet


Inserts a new worksheet into an Excel Spreadsheet



Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToInsert": {
    "Path": "string",
    "WorksheetName": "string"
  }
}
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

MergeDocument

Merge Multple Word DOCX Together

POST /convert/merge/docx


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



inputFile1: file
in formData

First input file to perform the operation on.

inputFile2: file
in formData

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

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Merge Multple PowerPoint PPTX Together

POST /convert/merge/pptx


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



inputFile1: file
in formData

First input file to perform the operation on.

inputFile2: file
in formData

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

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

Merge Multple Excel XLSX Together

POST /convert/merge/xlsx


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



inputFile1: file
in formData

First input file to perform the operation on.

inputFile2: file
in formData

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

Code Example:
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"

ValidateDocument

Validate a Word document (DOCX)

POST /convert/validate/docx


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "DocumentIsValid": "boolean",
  "ErrorCount": "integer (int32)",
  "WarningCount": "integer (int32)",
  "ErrorsAndWarnings": [
    {
      "Description": "string",
      "Path": "string",
      "Uri": "string",
      "IsError": "boolean"
    }
  ]
}

Validate a Excel document (XLSX)

POST /convert/validate/xlsx


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "DocumentIsValid": "boolean",
  "ErrorCount": "integer (int32)",
  "WarningCount": "integer (int32)",
  "ErrorsAndWarnings": [
    {
      "Description": "string",
      "Path": "string",
      "Uri": "string",
      "IsError": "boolean"
    }
  ]
}

Validate a PowerPoint presentation (PPTX)

POST /convert/validate/pptx


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:
Response Content-Types: application/octet-stream
Response Example (200 OK)
{
  "DocumentIsValid": "boolean",
  "ErrorCount": "integer (int32)",
  "WarningCount": "integer (int32)",
  "ErrorsAndWarnings": [
    {
      "Description": "string",
      "Path": "string",
      "Uri": "string",
      "IsError": "boolean"
    }
  ]
}

ViewerTools

Create a web-based viewer

POST /convert/viewer/create/web/simple


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



inputFile: file
in formData

Input file to perform the operation on.

Code Example:

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "HtmlEmbed": "string",
  "Successful": "boolean"
}

Schema Definitions

AutodetectGetInfoResult: object

Result of an autodetect/get-info operation

Successful: boolean

True if the operation was successful, false otherwise

DetectedFileExtension: string

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

DetectedMimeType: string

MIME type of this file extension

AlternateFileTypeCandidates: AlternateFileFormatCandidate

Alternate file type options and their probability

AlternateFileFormatCandidate
Example
{
  "Successful": "boolean",
  "DetectedFileExtension": "string",
  "DetectedMimeType": "string",
  "AlternateFileTypeCandidates": [
    {
      "Probability": "number (double)",
      "DetectedFileExtension": "string",
      "DetectedMimeType": "string"
    }
  ]
}

AlternateFileFormatCandidate: object

Alternate file format possibility

Probability: number (double)

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

DetectedFileExtension: string

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

DetectedMimeType: string

MIME type of this file extension

Example
{
  "Probability": "number (double)",
  "DetectedFileExtension": "string",
  "DetectedMimeType": "string"
}

PdfToPngResult: object

Result of converting a PDF to a PNG array

Successful: boolean

True if the operation was successful, false otherwise

PngResultPages: ConvertedPngPage

Array of converted pages

ConvertedPngPage
Example
{
  "Successful": "boolean",
  "PngResultPages": [
    {
      "PageNumber": "integer (int32)",
      "URL": "string"
    }
  ]
}

ConvertedPngPage: object

A single converted page

PageNumber: integer (int32)

Page number of the converted page, starting with 1

URL: string

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

Example
{
  "PageNumber": "integer (int32)",
  "URL": "string"
}

GetImageInfoResult: object

Result of running a get-info operation on an image

Successful: boolean
ColorSpace: string

Color space of the image

ColorType: string

Color type of the image

Width: integer (int32)

Width in pixels of the image

Height: integer (int32)

Height in pixels of the image

CompressionLevel: integer (int32)

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

ImageHashSignature: string

SHA256 hash signature of the image

HasTransparency: boolean

True if the image contains transparency, otherwise false

MimeType: string

MIME type of the image format

ImageFormat: string

Image format

DPIUnit: string

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

DPI: number (double)

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

ColorCount: integer (int32)

Unique colors in the image

BitDepth: integer (int32)

Bit depth of the image

Comment: string

Comment string in the image

ExifProfileName: string

Name of the EXIF profile used

ExifValues: ExifValue

EXIF tags and values embedded in the image

ExifValue
Example
{
  "Successful": "boolean",
  "ColorSpace": "string",
  "ColorType": "string",
  "Width": "integer (int32)",
  "Height": "integer (int32)",
  "CompressionLevel": "integer (int32)",
  "ImageHashSignature": "string",
  "HasTransparency": "boolean",
  "MimeType": "string",
  "ImageFormat": "string",
  "DPIUnit": "string",
  "DPI": "number (double)",
  "ColorCount": "integer (int32)",
  "BitDepth": "integer (int32)",
  "Comment": "string",
  "ExifProfileName": "string",
  "ExifValues": [
    {
      "Tag": "string",
      "DataType": "string",
      "DataValue": "string"
    }
  ]
}

ExifValue: object

EXIF tag and value

Tag: string
DataType: string
DataValue: string
Example
{
  "Tag": "string",
  "DataType": "string",
  "DataValue": "string"
}

HtmlTemplateApplicationRequest: object

HTML template application request

HtmlTemplate: string
HtmlTemplateUrl: string
Operations: HtmlTemplateOperation
HtmlTemplateOperation
Example
{
  "HtmlTemplate": "string",
  "HtmlTemplateUrl": "string",
  "Operations": [
    {
      "Action": "integer (int32)",
      "MatchAgsint": "string",
      "ReplaceWith": "string"
    }
  ]
}

HtmlTemplateOperation: object

Action: integer (int32) 1
MatchAgsint: string
ReplaceWith: string
Example
{
  "Action": "integer (int32)",
  "MatchAgsint": "string",
  "ReplaceWith": "string"
}

HtmlTemplateApplicationResponse: object

Response from an HTML template application

Successful: boolean
FinalHtml: string
Example
{
  "Successful": "boolean",
  "FinalHtml": "string"
}

ScreenshotRequest: object

Details of the screenshot request

Url: string
ExtraLoadingWait: integer (int32)
Example
{
  "Url": "string",
  "ExtraLoadingWait": "integer (int32)"
}

HtmlToPdfRequest: object

Details of the HTML to PDF request

Html: string
ExtraLoadingWait: integer (int32)
Example
{
  "Html": "string",
  "ExtraLoadingWait": "integer (int32)"
}

HtmlToOfficeRequest: object

Details of the HTML to Office request

Html: string
Example
{
  "Html": "string"
}

HtmlMdResult: object

Result from converting a Markdown file to HTML

Successful: boolean

True if operation was successful, false otherwise

Html: string

Resulting HTML from the conversion

Example
{
  "Successful": "boolean",
  "Html": "string"
}

FinishEditingRequest: object

Input to a Finish Editing request

InputFileUrl: string

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

Example
{
  "InputFileUrl": "string"
}

ReplaceStringRequest: object

Input to a string replacement request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

MatchString: string

String to search for and match against, to be replaced

ReplaceString: string

String to replace the matched values with

MatchCase: boolean

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "MatchString": "string",
  "ReplaceString": "string",
  "MatchCase": "boolean"
}

GetDocxTablesRequest: object

Input to a Get Tables request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetDocxTablesResponse: object

Result of running a Get-Tables command

Successful: boolean

True if successful, false otherwise

Tables: DocxTable

Tables in the DOCX file

DocxTable
Example
{
  "Successful": "boolean",
  "Tables": [
    {
      "TableID": "string",
      "Path": "string",
      "Width": "string",
      "WidthType": "string",
      "TableRows": [
        {
          "RowIndex": "integer (int32)",
          "Path": "string",
          "RowCells": [
            {
              "CellIndex": "integer (int32)",
              "Path": "string",
              "Paragraphs": [
                {
                  "ParagraphIndex": "integer (int32)",
                  "Path": "string",
                  "ContentRuns": [
                    {
                      "RunIndex": "integer (int32)",
                      "Path": "string",
                      "TextItems": [
                        {
                          "TextIndex": "integer (int32)",
                          "Path": "string",
                          "TextContent": "string"
                        }
                      ],
                      "Bold": "boolean",
                      "Italic": "boolean",
                      "Underline": "string",
                      "FontFamily": "string",
                      "FontSize": "string"
                    }
                  ],
                  "StyleID": "string"
                }
              ],
              "CellShadingColor": "string",
              "CellShadingFill": "string",
              "CellShadingPattern": "string",
              "CellWidthMode": "string",
              "CellWidth": "string"
            }
          ]
        }
      ],
      "TopBorderType": "string",
      "TopBorderSize": "integer (int32)",
      "TopBorderSpace": "integer (int32)",
      "TopBorderColor": "string",
      "BottomBorderType": "string",
      "BottomBorderSize": "integer (int32)",
      "BottomBorderSpace": "integer (int32)",
      "BottomBorderColor": "string",
      "LeftBorderType": "string",
      "LeftBorderSize": "integer (int32)",
      "LeftBorderSpace": "integer (int32)",
      "LeftBorderColor": "string",
      "RightBorderType": "string",
      "RightBorderSize": "integer (int32)",
      "RightBorderSpace": "integer (int32)",
      "RightBorderColor": "string",
      "CellHorizontalBorderType": "string",
      "CellHorizontalBorderSize": "integer (int32)",
      "CellHorizontalBorderSpace": "integer (int32)",
      "CellHorizontalBorderColor": "string",
      "CellVerticalBorderType": "string",
      "CellVerticalBorderSize": "integer (int32)",
      "CellVerticalBorderSpace": "integer (int32)",
      "CellVerticalBorderColor": "string",
      "StartBorderType": "string",
      "StartBorderSize": "integer (int32)",
      "StartBorderSpace": "integer (int32)",
      "StartBorderColor": "string",
      "EndBorderType": "string",
      "EndBorderSize": "integer (int32)",
      "EndBorderSpace": "integer (int32)",
      "EndBorderColor": "string",
      "TableIndentationMode": "string",
      "TableIndentationWidth": "integer (int32)"
    }
  ]
}

DocxTable: object

A table in a Word Document (DOCX) file

TableID: string

The ID of the table; leave blank for new tables

Path: string

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

Width: string

The Width of the table, or 0 if not specified

WidthType: string

The Width configuration type of the table

TableRows: DocxTableRow

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

DocxTableRow
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

TopBorderSize: integer (int32)

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

TopBorderSpace: integer (int32)

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

TopBorderColor: string

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

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

BottomBorderSize: integer (int32)

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

BottomBorderSpace: integer (int32)

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

BottomBorderColor: string

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

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

LeftBorderSize: integer (int32)

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

LeftBorderSpace: integer (int32)

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

LeftBorderColor: string

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

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

RightBorderSize: integer (int32)

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

RightBorderSpace: integer (int32)

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

RightBorderColor: string

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

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

CellHorizontalBorderSize: integer (int32)

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

CellHorizontalBorderSpace: integer (int32)

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

CellHorizontalBorderColor: string

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

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

CellVerticalBorderSize: integer (int32)

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

CellVerticalBorderSpace: integer (int32)

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

CellVerticalBorderColor: string

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

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

StartBorderSize: integer (int32)

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

StartBorderSpace: integer (int32)

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

StartBorderColor: string

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

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

EndBorderSize: integer (int32)

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

EndBorderSpace: integer (int32)

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

EndBorderColor: string

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

TableIndentationMode: string

Table indentation type

TableIndentationWidth: integer (int32)

Table indentation width

Example
{
  "TableID": "string",
  "Path": "string",
  "Width": "string",
  "WidthType": "string",
  "TableRows": [
    {
      "RowIndex": "integer (int32)",
      "Path": "string",
      "RowCells": [
        {
          "CellIndex": "integer (int32)",
          "Path": "string",
          "Paragraphs": [
            {
              "ParagraphIndex": "integer (int32)",
              "Path": "string",
              "ContentRuns": [
                {
                  "RunIndex": "integer (int32)",
                  "Path": "string",
                  "TextItems": [
                    {
                      "TextIndex": "integer (int32)",
                      "Path": "string",
                      "TextContent": "string"
                    }
                  ],
                  "Bold": "boolean",
                  "Italic": "boolean",
                  "Underline": "string",
                  "FontFamily": "string",
                  "FontSize": "string"
                }
              ],
              "StyleID": "string"
            }
          ],
          "CellShadingColor": "string",
          "CellShadingFill": "string",
          "CellShadingPattern": "string",
          "CellWidthMode": "string",
          "CellWidth": "string"
        }
      ]
    }
  ],
  "TopBorderType": "string",
  "TopBorderSize": "integer (int32)",
  "TopBorderSpace": "integer (int32)",
  "TopBorderColor": "string",
  "BottomBorderType": "string",
  "BottomBorderSize": "integer (int32)",
  "BottomBorderSpace": "integer (int32)",
  "BottomBorderColor": "string",
  "LeftBorderType": "string",
  "LeftBorderSize": "integer (int32)",
  "LeftBorderSpace": "integer (int32)",
  "LeftBorderColor": "string",
  "RightBorderType": "string",
  "RightBorderSize": "integer (int32)",
  "RightBorderSpace": "integer (int32)",
  "RightBorderColor": "string",
  "CellHorizontalBorderType": "string",
  "CellHorizontalBorderSize": "integer (int32)",
  "CellHorizontalBorderSpace": "integer (int32)",
  "CellHorizontalBorderColor": "string",
  "CellVerticalBorderType": "string",
  "CellVerticalBorderSize": "integer (int32)",
  "CellVerticalBorderSpace": "integer (int32)",
  "CellVerticalBorderColor": "string",
  "StartBorderType": "string",
  "StartBorderSize": "integer (int32)",
  "StartBorderSpace": "integer (int32)",
  "StartBorderColor": "string",
  "EndBorderType": "string",
  "EndBorderSize": "integer (int32)",
  "EndBorderSpace": "integer (int32)",
  "EndBorderColor": "string",
  "TableIndentationMode": "string",
  "TableIndentationWidth": "integer (int32)"
}

DocxTableRow: object

A row in a Word Document (DOCX) file

RowIndex: integer (int32)

Index of the row, 0-based

Path: string

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

RowCells: DocxTableCell

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

DocxTableCell
Example
{
  "RowIndex": "integer (int32)",
  "Path": "string",
  "RowCells": [
    {
      "CellIndex": "integer (int32)",
      "Path": "string",
      "Paragraphs": [
        {
          "ParagraphIndex": "integer (int32)",
          "Path": "string",
          "ContentRuns": [
            {
              "RunIndex": "integer (int32)",
              "Path": "string",
              "TextItems": [
                {
                  "TextIndex": "integer (int32)",
                  "Path": "string",
                  "TextContent": "string"
                }
              ],
              "Bold": "boolean",
              "Italic": "boolean",
              "Underline": "string",
              "FontFamily": "string",
              "FontSize": "string"
            }
          ],
          "StyleID": "string"
        }
      ],
      "CellShadingColor": "string",
      "CellShadingFill": "string",
      "CellShadingPattern": "string",
      "CellWidthMode": "string",
      "CellWidth": "string"
    }
  ]
}

DocxTableCell: object

A cell in a Word Document (DOCX) file

CellIndex: integer (int32)

The index of the cell, 0-based

Path: string

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

Paragraphs: DocxParagraph

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

DocxParagraph
CellShadingColor: string

Color of the cell shading

CellShadingFill: string

Fill of the cell shading

CellShadingPattern: string

Pattern of the cell shading

CellWidthMode: string

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

CellWidth: string

Width of the cell

Example
{
  "CellIndex": "integer (int32)",
  "Path": "string",
  "Paragraphs": [
    {
      "ParagraphIndex": "integer (int32)",
      "Path": "string",
      "ContentRuns": [
        {
          "RunIndex": "integer (int32)",
          "Path": "string",
          "TextItems": [
            {
              "TextIndex": "integer (int32)",
              "Path": "string",
              "TextContent": "string"
            }
          ],
          "Bold": "boolean",
          "Italic": "boolean",
          "Underline": "string",
          "FontFamily": "string",
          "FontSize": "string"
        }
      ],
      "StyleID": "string"
    }
  ],
  "CellShadingColor": "string",
  "CellShadingFill": "string",
  "CellShadingPattern": "string",
  "CellWidthMode": "string",
  "CellWidth": "string"
}

DocxParagraph: object

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

ParagraphIndex: integer (int32)

The index of the paragraph; 0-based

Path: string

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

ContentRuns: DocxRun

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

DocxRun
StyleID: string

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

Example
{
  "ParagraphIndex": "integer (int32)",
  "Path": "string",
  "ContentRuns": [
    {
      "RunIndex": "integer (int32)",
      "Path": "string",
      "TextItems": [
        {
          "TextIndex": "integer (int32)",
          "Path": "string",
          "TextContent": "string"
        }
      ],
      "Bold": "boolean",
      "Italic": "boolean",
      "Underline": "string",
      "FontFamily": "string",
      "FontSize": "string"
    }
  ],
  "StyleID": "string"
}

DocxRun: object

A content run in a Word Document (DOCX) file

RunIndex: integer (int32)

Index of the run, 0-based

Path: string

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

TextItems: DocxText

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

DocxText
Bold: boolean

True to make the text bold, false otherwise

Italic: boolean

True to make the text italic, false otherwise

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

FontFamily: string

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

FontSize: string

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

Example
{
  "RunIndex": "integer (int32)",
  "Path": "string",
  "TextItems": [
    {
      "TextIndex": "integer (int32)",
      "Path": "string",
      "TextContent": "string"
    }
  ],
  "Bold": "boolean",
  "Italic": "boolean",
  "Underline": "string",
  "FontFamily": "string",
  "FontSize": "string"
}

DocxText: object

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

TextIndex: integer (int32)

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

Path: string

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

TextContent: string

Text string containing the text content of this text content item

Example
{
  "TextIndex": "integer (int32)",
  "Path": "string",
  "TextContent": "string"
}

GetDocxImagesRequest: object

Input to a Get Images request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetDocxImagesResponse: object

Result of running a Get-Images command

Successful: boolean

True if successful, false otherwise

Images: DocxImage

Images in the DOCX document

DocxImage
Example
{
  "Successful": "boolean",
  "Images": [
    {
      "Path": "string",
      "ImageName": "string",
      "ImageId": "integer (int64)",
      "ImageDescription": "string",
      "ImageWidth": "integer (int64)",
      "ImageHeight": "integer (int64)",
      "XOffset": "integer (int64)",
      "YOffset": "integer (int64)",
      "ImageDataEmbedId": "string",
      "ImageDataContentType": "string",
      "ImageInternalFileName": "string",
      "ImageContentsURL": "string",
      "InlineWithText": "boolean"
    }
  ]
}

DocxImage: object

Path: string

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

ImageName: string

The Name of the image

ImageId: integer (int64)

The Id of the image

ImageDescription: string

The Description of the image

ImageWidth: integer (int64)

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

ImageHeight: integer (int64)

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

XOffset: integer (int64)

X (horizontal) offset of the image

YOffset: integer (int64)

Y (vertical) offset of the image

ImageDataEmbedId: string

Read-only; internal ID for the image contents

ImageDataContentType: string

Read-only; image data MIME content-type

ImageInternalFileName: string

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

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.

InlineWithText: boolean

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

Example
{
  "Path": "string",
  "ImageName": "string",
  "ImageId": "integer (int64)",
  "ImageDescription": "string",
  "ImageWidth": "integer (int64)",
  "ImageHeight": "integer (int64)",
  "XOffset": "integer (int64)",
  "YOffset": "integer (int64)",
  "ImageDataEmbedId": "string",
  "ImageDataContentType": "string",
  "ImageInternalFileName": "string",
  "ImageContentsURL": "string",
  "InlineWithText": "boolean"
}

GetDocxStylesRequest: object

Input to a Get Tables request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetDocxStylesResponse: object

Result of running a Get-Tables command

Successful: boolean

True if successful, false otherwise

Styles: DocxStyle

Styles in the DOCX document

DocxStyle
Example
{
  "Successful": "boolean",
  "Styles": [
    {
      "StyleID": "string",
      "Path": "string",
      "Bold": "boolean",
      "Italic": "boolean",
      "Underline": "boolean",
      "FontSize": "string",
      "FontFamily": "string"
    }
  ]
}

DocxStyle: object

Style in a DOCX Word Document

StyleID: string

ID of the style

Path: string

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

Bold: boolean

Style applies bold formatting

Italic: boolean

Style applies italic formatting

Underline: boolean

Style applies underline formatting

FontSize: string

Font size

FontFamily: string

Font family

Example
{
  "StyleID": "string",
  "Path": "string",
  "Bold": "boolean",
  "Italic": "boolean",
  "Underline": "boolean",
  "FontSize": "string",
  "FontFamily": "string"
}

GetDocxSectionsRequest: object

Input to a Get Sections request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetDocxSectionsResponse: object

Result of running a Get-Sections command

Successful: boolean

True if successful, false otherwise

Sections: DocxSection

Sections in the DOCX document

DocxSection
Example
{
  "Successful": "boolean",
  "Sections": [
    {
      "StartingPageNumbers": [
        "integer (int32)"
      ],
      "Path": "string"
    }
  ]
}

DocxSection: object

Section of a Word Document (DOCX)

StartingPageNumbers: integer[]

Page numbers that the section starts at, typically just one

integer (int32)
Path: string

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

Example
{
  "StartingPageNumbers": [
    "integer (int32)"
  ],
  "Path": "string"
}

GetDocxBodyRequest: object

Input to a Get Body request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetDocxBodyResponse: object

Result of running a Get-Body command

Successful: boolean

True if successful, false otherwise

Body: DocxBody

Body in the DOCX document

Example
{
  "Successful": "boolean",
  "Body": {
    "Path": "string",
    "AllParagraphs": [
      {
        "ParagraphIndex": "integer (int32)",
        "Path": "string",
        "ContentRuns": [
          {
            "RunIndex": "integer (int32)",
            "Path": "string",
            "TextItems": [
              {
                "TextIndex": "integer (int32)",
                "Path": "string",
                "TextContent": "string"
              }
            ],
            "Bold": "boolean",
            "Italic": "boolean",
            "Underline": "string",
            "FontFamily": "string",
            "FontSize": "string"
          }
        ],
        "StyleID": "string"
      }
    ],
    "AllTables": [
      {
        "TableID": "string",
        "Path": "string",
        "Width": "string",
        "WidthType": "string",
        "TableRows": [
          {
            "RowIndex": "integer (int32)",
            "Path": "string",
            "RowCells": [
              {
                "CellIndex": "integer (int32)",
                "Path": "string",
                "Paragraphs": [
                  {
                    "ParagraphIndex": "integer (int32)",
                    "Path": "string",
                    "ContentRuns": [
                      {
                        "RunIndex": "integer (int32)",
                        "Path": "string",
                        "TextItems": [
                          {
                            "TextIndex": "integer (int32)",
                            "Path": "string",
                            "TextContent": "string"
                          }
                        ],
                        "Bold": "boolean",
                        "Italic": "boolean",
                        "Underline": "string",
                        "FontFamily": "string",
                        "FontSize": "string"
                      }
                    ],
                    "StyleID": "string"
                  }
                ],
                "CellShadingColor": "string",
                "CellShadingFill": "string",
                "CellShadingPattern": "string",
                "CellWidthMode": "string",
                "CellWidth": "string"
              }
            ]
          }
        ],
        "TopBorderType": "string",
        "TopBorderSize": "integer (int32)",
        "TopBorderSpace": "integer (int32)",
        "TopBorderColor": "string",
        "BottomBorderType": "string",
        "BottomBorderSize": "integer (int32)",
        "BottomBorderSpace": "integer (int32)",
        "BottomBorderColor": "string",
        "LeftBorderType": "string",
        "LeftBorderSize": "integer (int32)",
        "LeftBorderSpace": "integer (int32)",
        "LeftBorderColor": "string",
        "RightBorderType": "string",
        "RightBorderSize": "integer (int32)",
        "RightBorderSpace": "integer (int32)",
        "RightBorderColor": "string",
        "CellHorizontalBorderType": "string",
        "CellHorizontalBorderSize": "integer (int32)",
        "CellHorizontalBorderSpace": "integer (int32)",
        "CellHorizontalBorderColor": "string",
        "CellVerticalBorderType": "string",
        "CellVerticalBorderSize": "integer (int32)",
        "CellVerticalBorderSpace": "integer (int32)",
        "CellVerticalBorderColor": "string",
        "StartBorderType": "string",
        "StartBorderSize": "integer (int32)",
        "StartBorderSpace": "integer (int32)",
        "StartBorderColor": "string",
        "EndBorderType": "string"
      }
    ]
  }
}

DocxBody: object

Path: string

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

AllParagraphs: DocxParagraph

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

DocxParagraph
AllTables: DocxTable

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

DocxTable
Example
{
  "Path": "string",
  "AllParagraphs": [
    {
      "ParagraphIndex": "integer (int32)",
      "Path": "string",
      "ContentRuns": [
        {
          "RunIndex": "integer (int32)",
          "Path": "string",
          "TextItems": [
            {
              "TextIndex": "integer (int32)",
              "Path": "string",
              "TextContent": "string"
            }
          ],
          "Bold": "boolean",
          "Italic": "boolean",
          "Underline": "string",
          "FontFamily": "string",
          "FontSize": "string"
        }
      ],
      "StyleID": "string"
    }
  ],
  "AllTables": [
    {
      "TableID": "string",
      "Path": "string",
      "Width": "string",
      "WidthType": "string",
      "TableRows": [
        {
          "RowIndex": "integer (int32)",
          "Path": "string",
          "RowCells": [
            {
              "CellIndex": "integer (int32)",
              "Path": "string",
              "Paragraphs": [
                {
                  "ParagraphIndex": "integer (int32)",
                  "Path": "string",
                  "ContentRuns": [
                    {
                      "RunIndex": "integer (int32)",
                      "Path": "string",
                      "TextItems": [
                        {
                          "TextIndex": "integer (int32)",
                          "Path": "string",
                          "TextContent": "string"
                        }
                      ],
                      "Bold": "boolean",
                      "Italic": "boolean",
                      "Underline": "string",
                      "FontFamily": "string",
                      "FontSize": "string"
                    }
                  ],
                  "StyleID": "string"
                }
              ],
              "CellShadingColor": "string",
              "CellShadingFill": "string",
              "CellShadingPattern": "string",
              "CellWidthMode": "string",
              "CellWidth": "string"
            }
          ]
        }
      ],
      "TopBorderType": "string",
      "TopBorderSize": "integer (int32)",
      "TopBorderSpace": "integer (int32)",
      "TopBorderColor": "string",
      "BottomBorderType": "string",
      "BottomBorderSize": "integer (int32)",
      "BottomBorderSpace": "integer (int32)",
      "BottomBorderColor": "string",
      "LeftBorderType": "string",
      "LeftBorderSize": "integer (int32)",
      "LeftBorderSpace": "integer (int32)",
      "LeftBorderColor": "string",
      "RightBorderType": "string",
      "RightBorderSize": "integer (int32)",
      "RightBorderSpace": "integer (int32)",
      "RightBorderColor": "string",
      "CellHorizontalBorderType": "string",
      "CellHorizontalBorderSize": "integer (int32)",
      "CellHorizontalBorderSpace": "integer (int32)",
      "CellHorizontalBorderColor": "string",
      "CellVerticalBorderType": "string",
      "CellVerticalBorderSize": "integer (int32)",
      "CellVerticalBorderSpace": "integer (int32)",
      "CellVerticalBorderColor": "string",
      "StartBorderType": "string",
      "StartBorderSize": "integer (int32)",
      "StartBorderSpace": "integer (int32)",
      "StartBorderColor": "string",
      "EndBorderType": "string",
      "EndBorderSize": "integer (int32)",
      "EndBorderSpace": "integer (int32)",
      "EndBorderColor": "string"
    }
  ]
}

GetDocxHeadersAndFootersRequest: object

Input to a Get Tables request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetDocxHeadersAndFootersResponse: object

Result of running a Get-Tables command

Successful: boolean

True if successful, false otherwise

Headers: DocxHeader
DocxHeader
Footers: DocxFooter
DocxFooter
Example
{
  "Successful": "boolean",
  "Headers": [
    {
      "Path": "string",
      "Paragraphs": [
        {
          "ParagraphIndex": "integer (int32)",
          "Path": "string",
          "ContentRuns": [
            {
              "RunIndex": "integer (int32)",
              "Path": "string",
              "TextItems": [
                {
                  "TextIndex": "integer (int32)",
                  "Path": "string",
                  "TextContent": "string"
                }
              ],
              "Bold": "boolean",
              "Italic": "boolean",
              "Underline": "string",
              "FontFamily": "string",
              "FontSize": "string"
            }
          ],
          "StyleID": "string"
        }
      ],
      "SectionsWithHeader": [
        {
          "StartingPageNumbers": [
            "integer (int32)"
          ],
          "Path": "string"
        }
      ]
    }
  ],
  "Footers": [
    {
      "Path": "string",
      "Paragraphs": [
        {
          "ParagraphIndex": "integer (int32)",
          "Path": "string",
          "ContentRuns": [
            {
              "RunIndex": "integer (int32)",
              "Path": "string",
              "TextItems": [
                {
                  "TextIndex": "integer (int32)",
                  "Path": "string",
                  "TextContent": "string"
                }
              ],
              "Bold": "boolean",
              "Italic": "boolean",
              "Underline": "string",
              "FontFamily": "string",
              "FontSize": "string"
            }
          ],
          "StyleID": "string"
        }
      ],
      "SectionsWithFooter": [
        {
          "StartingPageNumbers": [
            "integer (int32)"
          ],
          "Path": "string"
        }
      ]
    }
  ]
}

DocxHeader: object

Header of a Word Document (DOCX)

Path: string

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

Paragraphs: DocxParagraph

Paragraphs in this header

DocxParagraph
SectionsWithHeader: DocxSection

Sections that the header is applied to

DocxSection
Example
{
  "Path": "string",
  "Paragraphs": [
    {
      "ParagraphIndex": "integer (int32)",
      "Path": "string",
      "ContentRuns": [
        {
          "RunIndex": "integer (int32)",
          "Path": "string",
          "TextItems": [
            {
              "TextIndex": "integer (int32)",
              "Path": "string",
              "TextContent": "string"
            }
          ],
          "Bold": "boolean",
          "Italic": "boolean",
          "Underline": "string",
          "FontFamily": "string",
          "FontSize": "string"
        }
      ],
      "StyleID": "string"
    }
  ],
  "SectionsWithHeader": [
    {
      "StartingPageNumbers": [
        "integer (int32)"
      ],
      "Path": "string"
    }
  ]
}

DocxFooter: object

Footer in a Word Document (DOCX)

Path: string

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

Paragraphs: DocxParagraph

Paragraphs in this footer

DocxParagraph
SectionsWithFooter: DocxSection

Sections that the footer is applied to

DocxSection
Example
{
  "Path": "string",
  "Paragraphs": [
    {
      "ParagraphIndex": "integer (int32)",
      "Path": "string",
      "ContentRuns": [
        {
          "RunIndex": "integer (int32)",
          "Path": "string",
          "TextItems": [
            {
              "TextIndex": "integer (int32)",
              "Path": "string",
              "TextContent": "string"
            }
          ],
          "Bold": "boolean",
          "Italic": "boolean",
          "Underline": "string",
          "FontFamily": "string",
          "FontSize": "string"
        }
      ],
      "StyleID": "string"
    }
  ],
  "SectionsWithFooter": [
    {
      "StartingPageNumbers": [
        "integer (int32)"
      ],
      "Path": "string"
    }
  ]
}

DocxSetHeaderRequest: object

Input to a set-header command

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

HeaderToApply: DocxHeader

Header to apply

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "HeaderToApply": {
    "Path": "string",
    "Paragraphs": [
      {
        "ParagraphIndex": "integer (int32)",
        "Path": "string",
        "ContentRuns": [
          {
            "RunIndex": "integer (int32)",
            "Path": "string",
            "TextItems": [
              {
                "TextIndex": "integer (int32)",
                "Path": "string",
                "TextContent": "string"
              }
            ],
            "Bold": "boolean",
            "Italic": "boolean",
            "Underline": "string",
            "FontFamily": "string",
            "FontSize": "string"
          }
        ],
        "StyleID": "string"
      }
    ],
    "SectionsWithHeader": [
      {
        "StartingPageNumbers": [
          "integer (int32)"
        ],
        "Path": "string"
      }
    ]
  }
}

DocxSetHeaderResponse: object

Result of running a set-header command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

DocxSetFooterRequest: object

Input to set-footer command

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

FooterToApply: DocxFooter

Footer to apply

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "FooterToApply": {
    "Path": "string",
    "Paragraphs": [
      {
        "ParagraphIndex": "integer (int32)",
        "Path": "string",
        "ContentRuns": [
          {
            "RunIndex": "integer (int32)",
            "Path": "string",
            "TextItems": [
              {
                "TextIndex": "integer (int32)",
                "Path": "string",
                "TextContent": "string"
              }
            ],
            "Bold": "boolean",
            "Italic": "boolean",
            "Underline": "string",
            "FontFamily": "string",
            "FontSize": "string"
          }
        ],
        "StyleID": "string"
      }
    ],
    "SectionsWithFooter": [
      {
        "StartingPageNumbers": [
          "integer (int32)"
        ],
        "Path": "string"
      }
    ]
  }
}

DocxSetFooterResponse: object

Result of running a set-footer command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

DocxInsertImageRequest: object

Input to set-footer command

InputDocumentFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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: string (byte)

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

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

ImageToAdd: DocxImage

Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl.

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)

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

Example
{
  "InputDocumentFileBytes": "string (byte)",
  "InputDocumentFileUrl": "string",
  "InputImageFileBytes": "string (byte)",
  "InputImageFileUrl": "string",
  "ImageToAdd": {
    "Path": "string",
    "ImageName": "string",
    "ImageId": "integer (int64)",
    "ImageDescription": "string",
    "ImageWidth": "integer (int64)",
    "ImageHeight": "integer (int64)",
    "XOffset": "integer (int64)",
    "YOffset": "integer (int64)",
    "ImageDataEmbedId": "string",
    "ImageDataContentType": "string",
    "ImageInternalFileName": "string",
    "ImageContentsURL": "string",
    "InlineWithText": "boolean"
  },
  "InsertPlacement": "string",
  "InsertPath": "string"
}

DocxInsertImageResponse: object

Result of running a set-footer command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

InsertDocxInsertParagraphRequest: object

Input to a Insert Paragraph request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

ParagraphToInsert: DocxParagraph

Table you would like to insert

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)

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "ParagraphToInsert": {
    "ParagraphIndex": "integer (int32)",
    "Path": "string",
    "ContentRuns": [
      {
        "RunIndex": "integer (int32)",
        "Path": "string",
        "TextItems": [
          {
            "TextIndex": "integer (int32)",
            "Path": "string",
            "TextContent": "string"
          }
        ],
        "Bold": "boolean",
        "Italic": "boolean",
        "Underline": "string",
        "FontFamily": "string",
        "FontSize": "string"
      }
    ],
    "StyleID": "string"
  },
  "InsertPlacement": "string",
  "InsertPath": "string"
}

InsertDocxInsertParagraphResponse: object

Result of running an Insert-Paragraph command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

InsertDocxTablesRequest: object

Input to a Insert Tables request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

TableToInsert: DocxTable

Table you would like to insert

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)

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "TableToInsert": {
    "TableID": "string",
    "Path": "string",
    "Width": "string",
    "WidthType": "string",
    "TableRows": [
      {
        "RowIndex": "integer (int32)",
        "Path": "string",
        "RowCells": [
          {
            "CellIndex": "integer (int32)",
            "Path": "string",
            "Paragraphs": [
              {
                "ParagraphIndex": "integer (int32)",
                "Path": "string",
                "ContentRuns": [
                  {
                    "RunIndex": "integer (int32)",
                    "Path": "string",
                    "TextItems": [
                      {
                        "TextIndex": "integer (int32)",
                        "Path": "string",
                        "TextContent": "string"
                      }
                    ],
                    "Bold": "boolean",
                    "Italic": "boolean",
                    "Underline": "string",
                    "FontFamily": "string",
                    "FontSize": "string"
                  }
                ],
                "StyleID": "string"
              }
            ],
            "CellShadingColor": "string",
            "CellShadingFill": "string",
            "CellShadingPattern": "string",
            "CellWidthMode": "string",
            "CellWidth": "string"
          }
        ]
      }
    ],
    "TopBorderType": "string",
    "TopBorderSize": "integer (int32)",
    "TopBorderSpace": "integer (int32)",
    "TopBorderColor": "string",
    "BottomBorderType": "string",
    "BottomBorderSize": "integer (int32)",
    "BottomBorderSpace": "integer (int32)",
    "BottomBorderColor": "string",
    "LeftBorderType": "string",
    "LeftBorderSize": "integer (int32)",
    "LeftBorderSpace": "integer (int32)",
    "LeftBorderColor": "string",
    "RightBorderType": "string",
    "RightBorderSize": "integer (int32)",
    "RightBorderSpace": "integer (int32)",
    "RightBorderColor": "string",
    "CellHorizontalBorderType": "string",
    "CellHorizontalBorderSize": "integer (int32)",
    "CellHorizontalBorderSpace": "integer (int32)",
    "CellHorizontalBorderColor": "string",
    "CellVerticalBorderType": "string",
    "CellVerticalBorderSize": "integer (int32)",
    "CellVerticalBorderSpace": "integer (int32)",
    "CellVerticalBorderColor": "string",
    "StartBorderType": "string",
    "StartBorderSize": "integer (int32)",
    "StartBorderSpace": "integer (int32)",
    "StartBorderColor": "string",
    "EndBorderType": "string",
    "EndBorderSize": "integer (int32)",
    "EndBorderSpace": "integer (int32)",
    "EndBorderColor": "string",
    "TableIndentationMode": "string",
    "TableIndentationWidth": "integer (int32)"
  },
  "InsertPlacement": "string",
  "InsertPath": "string"
}

InsertDocxTablesResponse: object

Result of running an Insert-Tables command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

RemoveDocxHeadersAndFootersRequest: object

Input to a Remove Headers and Footers request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

RemoveHeaders: boolean

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

RemoveFooters: boolean

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "RemoveHeaders": "boolean",
  "RemoveFooters": "boolean"
}

RemoveDocxHeadersAndFootersResponse: object

Result of running a Remove Headers and Footers command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

DocxRemoveObjectRequest: object

Input to a Insert Paragraph request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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: string

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "PathToObjectToRemove": "string"
}

DocxRemoveObjectResponse: object

Result of running an Remove-Object command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

GetXlsxWorksheetsRequest: object

Input to a Get Worksheets request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetXlsxWorksheetsResponse: object

Result of running a Get-Worksheets command

Successful: boolean

True if successful, false otherwise

Worksheets: XlsxWorksheet

Styles in the DOCX document

XlsxWorksheet
Example
{
  "Successful": "boolean",
  "Worksheets": [
    {
      "Path": "string",
      "WorksheetName": "string"
    }
  ]
}

XlsxWorksheet: object

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

Path: string

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

WorksheetName: string

User-facing name of the worksheet tab

Example
{
  "Path": "string",
  "WorksheetName": "string"
}

GetXlsxRowsAndCellsRequest: object

Input to a Get Worksheets request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

WorksheetToQuery: XlsxWorksheet

Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToQuery": {
    "Path": "string",
    "WorksheetName": "string"
  }
}

GetXlsxRowsAndCellsResponse: object

Result of running a Get-Worksheets command

Successful: boolean

True if successful, false otherwise

Rows: XlsxSpreadsheetRow

Spreadsheet Rows in the DOCX document

XlsxSpreadsheetRow
Example
{
  "Successful": "boolean",
  "Rows": [
    {
      "Path": "string",
      "Cells": [
        {
          "Path": "string",
          "TextValue": "string",
          "CellIdentifier": "string",
          "StyleIndex": "integer (int32)",
          "Formula": "string"
        }
      ]
    }
  ]
}

XlsxSpreadsheetRow: object

Row in an Excel spreadsheet worksheet

Path: string

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

Cells: XlsxSpreadsheetCell

Spreadsheet Cells in the spreadsheet row

XlsxSpreadsheetCell
Example
{
  "Path": "string",
  "Cells": [
    {
      "Path": "string",
      "TextValue": "string",
      "CellIdentifier": "string",
      "StyleIndex": "integer (int32)",
      "Formula": "string"
    }
  ]
}

XlsxSpreadsheetCell: object

Cell in an Excel Spreadsheet worksheet

Path: string

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

TextValue: string

Text value of the cell

CellIdentifier: string

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

StyleIndex: integer (int32)

Identifier for the style to apply to this style

Formula: string
Example
{
  "Path": "string",
  "TextValue": "string",
  "CellIdentifier": "string",
  "StyleIndex": "integer (int32)",
  "Formula": "string"
}

GetXlsxColumnsRequest: object

Input to a Get Columns request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

WorksheetToQuery: XlsxWorksheet

Optional; Worksheet (tab) within the spreadsheet to get the columns of; leave blank to default to the first worksheet

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToQuery": {
    "Path": "string",
    "WorksheetName": "string"
  }
}

GetXlsxColumnsResponse: object

Result of running a Get-Columns command

Successful: boolean

True if successful, false otherwise

Columns: XlsxSpreadsheetColumn

Spreadsheet Columns in the DOCX document

XlsxSpreadsheetColumn
Example
{
  "Successful": "boolean",
  "Columns": [
    {
      "Path": "string",
      "HeadingCell": {
        "Path": "string",
        "TextValue": "string",
        "CellIdentifier": "string",
        "StyleIndex": "integer (int32)",
        "Formula": "string"
      }
    }
  ]
}

XlsxSpreadsheetColumn: object

Column in an Excel spreadsheet worksheet

Path: string

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

HeadingCell: XlsxSpreadsheetCell

Heading cell for this column

Example
{
  "Path": "string",
  "HeadingCell": {
    "Path": "string",
    "TextValue": "string",
    "CellIdentifier": "string",
    "StyleIndex": "integer (int32)",
    "Formula": "string"
  }
}

GetXlsxImagesRequest: object

Input to a Get Images request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

WorksheetToQuery: XlsxWorksheet

Optional; Worksheet (tab) within the spreadsheet to get the images of; leave blank to default to the first worksheet

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToQuery": {
    "Path": "string",
    "WorksheetName": "string"
  }
}

GetXlsxImagesResponse: object

Result of running a Get-Images command

Successful: boolean

True if successful, false otherwise

Images: XlsxImage

Spreadsheet Columns in the DOCX document

XlsxImage
Example
{
  "Successful": "boolean",
  "Images": [
    {
      "Path": "string",
      "ImageDataEmbedId": "string",
      "ImageDataContentType": "string",
      "ImageInternalFileName": "string",
      "ImageContentsURL": "string"
    }
  ]
}

XlsxImage: object

Path: string

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

ImageDataEmbedId: string

Read-only; internal ID for the image contents

ImageDataContentType: string

Read-only; image data MIME content-type

ImageInternalFileName: string

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

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.

Example
{
  "Path": "string",
  "ImageDataEmbedId": "string",
  "ImageDataContentType": "string",
  "ImageInternalFileName": "string",
  "ImageContentsURL": "string"
}

GetXlsxStylesRequest: object

Input to a Get Worksheets request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string"
}

GetXlsxStylesResponse: object

Result of running a Get-Worksheets command

Successful: boolean

True if successful, false otherwise

CellStyles: DocxCellStyle

Cell styles

DocxCellStyle
Example
{
  "Successful": "boolean",
  "CellStyles": [
    {
      "Path": "string",
      "Name": "string",
      "FormatID": "integer (int32)",
      "BuiltInID": "integer (int32)"
    }
  ]
}

DocxCellStyle: object

Style in an Excel spreadsheet

Path: string

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

Name: string

Name of the style

FormatID: integer (int32)

Format ID of the cell style

BuiltInID: integer (int32)

Built=in ID of the cell style

Example
{
  "Path": "string",
  "Name": "string",
  "FormatID": "integer (int32)",
  "BuiltInID": "integer (int32)"
}

InsertXlsxWorksheetRequest: object

Input to a Get Worksheets request

InputFileBytes: string (byte)

Optional: Bytes of the input file to operate on

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

WorksheetToInsert: XlsxWorksheet

Workersheet to insert

Example
{
  "InputFileBytes": "string (byte)",
  "InputFileUrl": "string",
  "WorksheetToInsert": {
    "Path": "string",
    "WorksheetName": "string"
  }
}

InsertXlsxWorksheetResponse: object

Result of running a Get-Worksheets command

Successful: boolean

True if successful, false otherwise

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.

Example
{
  "Successful": "boolean",
  "EditedDocumentURL": "string"
}

DocumentValidationResult: object

Document validation result

DocumentIsValid: boolean

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

ErrorCount: integer (int32)

Number of validation errors found in the document

WarningCount: integer (int32)

Number of validation warnings found in the document

ErrorsAndWarnings: DocumentValidationError

Details of errors and warnings found

DocumentValidationError
Example
{
  "DocumentIsValid": "boolean",
  "ErrorCount": "integer (int32)",
  "WarningCount": "integer (int32)",
  "ErrorsAndWarnings": [
    {
      "Description": "string",
      "Path": "string",
      "Uri": "string",
      "IsError": "boolean"
    }
  ]
}

DocumentValidationError: object

Validation error found in document

Description: string

Description of the error

Path: string

XPath to the error

Uri: string

URI of the part in question

IsError: boolean

True if this is an error, false otherwise

Example
{
  "Description": "string",
  "Path": "string",
  "Uri": "string",
  "IsError": "boolean"
}

ViewerResponse: object

Result of creating a viewer

HtmlEmbed: string
Successful: boolean
Example
{
  "HtmlEmbed": "string",
  "Successful": "boolean"
}