DOTX to TIFF API.

The API for converting Word DOTX documents to TIFF images.

API Request

Authentication Parameters
Parameter Description Value
Secret

Optional

String

Authentication secret must be provided as a query parameter. If omitted, token must be provided.

 Secret
Token

Optional

String

Authentication token must be provided as a query parameter. If omitted, secret must be provided.

 Token
Input Parameters
Parameter Description Value
File

Required

File

File to be converted. Value can be URL or file content.

 File
Output Parameters
Parameter Description Value
StoreFile

Optional

Bool

Store converted file on our secure server and provides download URL.

Default: False

StoreFile
FileName

Optional

String

Converted output file name without extension. The extension will be added automatically.

 FileName
Execution Parameters
Parameter Description Value
Timeout

Optional

Integer

Conversion timeout in seconds.

Default: 300

Values: 10 .. 1200

Timeout
Asynchronous Parameters
Parameter Description Value
Async

Optional

Bool

Run conversion job asynchronously.

Default: False

Async
JobId

Optional

String

Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

 JobId
WebHook

Optional

String

Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

 WebHook
Word Options Parameters
Parameter Description Value
DocumentPassword

Optional

String

Sets the password to open protected documents.

 DocumentPassword
PageRange

Optional

String

Set page range.

Default: 1-999

PageRange
PageOrientation

Optional

Collection

Page orientation.

Default: default

Values: default, portrait, landscape

PageOrientation
PageSize

Optional

Collection

Page size.

Default: default

Values: default, letter, lettersmall, tabloid, ledger, legal, statement, executive, a3, a4, a4small, a5, b4, b5, folio, quarto, 10x14, 11x17, note, envelope9, envelope10, envelope11, envelope12, envelope14, csheet, dsheet, esheet, envelopedl, envelopec3, envelopec4, envelopec5, envelopec6, envelopec65, envelopecb4, envelopeb5, envelopeb6, envelopeeurope, envelopem, envelopeusa, fanfoldusa, fanfoldgerman, lfanfoldgerman

PageSize
Image Options Parameters
Parameter Description Value
ImageResolutionH

Optional

Integer

Set output image horizontal resolution in dpi.

Default: 300

Values: 1 .. 3000

ImageResolutionH
ImageResolutionV

Optional

Integer

Set output image vertical resolution in dpi.

Default: 300

Values: 1 .. 3000

ImageResolutionV
ScaleImage

Optional

Bool

Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.

Default: False

ScaleImage
ScaleProportions

Optional

Bool

Constrain proportions when scaling the output image.

Default: False

ScaleProportions
ScaleIfLarger

Optional

Bool

Scaling only if the input image is larger than the output.

Default: False

ScaleIfLarger
ImageHeight

Optional

Integer

Image height in pixels.

Values: 10 .. 5000

ImageHeight
ImageWidth

Optional

Integer

Image width in pixels.

Values: 10 .. 5000

ImageWidth
TextAntialiasing

Optional

Collection

Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.

Default: 1

Values: 0, 1, 2, 4

TextAntialiasing
GraphicsAntialiasing

Optional

Collection

Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.

Default: 1

Values: 0, 1, 2, 4

GraphicsAntialiasing
ImageInterpolation

Optional

Bool

Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.

Default: False

ImageInterpolation
UseCIEColor

Optional

Bool

Specifies whether the image parser should remap the device-dependent.

Default: False

UseCIEColor
TIFF Output Parameters
Parameter Description Value
TiffType

Optional

Collection

Set TIFF type.

Default: color24lzw

Values: color24nc, color32nc, color24lzw, color32lzw, color24zip, color32zip, grayscale, grayscalelzw, grayscalezip, monochromeg3, monochromeg32d, monochromeg4, monochromelzw, monochromepackbits

TiffType
MultiPage

Optional

Bool

Create multi-page TIFF file.

Default: True

MultiPage
FillOrder

Optional

Collection

The logical order of bits within a byte.

Default: 0

Values: 0, 1

FillOrder

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program