PDF to TIFF-FAX API.

The API for converting PDF documents to TIFF-FAX 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
Image Options Parameters
Parameter Description Value
ImageResolution

Optional

Collection

Set output image resolution in dpi.

Default: 204x98

Values: 204x98, 204x196

ImageResolution
ImageWidth

Optional

Collection

Image width in pixels.

Default: 1728

Values: 1728, 2048, 2482

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
DitheringMethod

Optional

Collection

Specifies the dithering algorithm.

Default: default

Values: default, sierra, burkes, stucki, floyd, jarvis, cluster6, cluster8, cluster16, bayer4, bayer8

DitheringMethod
Wts

Optional

Bool

Use Well Tempered Screening algorithm for halftoning.

Default: False

Wts
TIFF Output Parameters
Parameter Description Value
TiffType

Optional

Collection

Set TIFF FAX type.

Default: monochromeg4

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