ConvertApi Logo

DOC to PNG API

The API for converting Word DOC documents to PNG images.

API Request:
Copy parameter's URL Secret Secret
Optional

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

Show all
Copy parameter's URL Token Token
Optional

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

Show all
Copy parameter's URL File File
Required

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

Show all
Copy parameter's URL StoreFile Store file
Optional

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

Default: False

Show all
Copy parameter's URL FileName File name
Optional

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

Show all
Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Password Open Password
Optional

String Sets the password to open protected documents.

Show all
Copy parameter's URL PageRange Page Range
Optional

String Set page range.

Default: 1-2000

Show all
Copy parameter's URL PageOrientation Page orientation
Optional

Collection Page orientation.

Default: default

Values: default, portrait, landscape

Show all
Copy parameter's URL PageSize Page size
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

Show all
Copy parameter's URL ImageResolutionH Horizontal image resolution
Optional

Integer Set output image horizontal resolution in dpi.

Default: 200

Range: 1 .. 3000

Show all
Copy parameter's URL ImageResolutionV Vertical image resolution
Optional

Integer Set output image vertical resolution in dpi.

Default: 200

Range: 1 .. 3000

Show all
Copy parameter's URL ScaleImage Scale image
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

Show all
Copy parameter's URL ScaleProportions Scale proportions
Optional

Bool Constrain proportions when scaling the output image.

Default: True

Show all
Copy parameter's URL ScaleIfLarger Scale if larger
Optional

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

Default: False

Show all
Copy parameter's URL ImageHeight Image height
Optional

Integer Image height in pixels.

Range: 10 .. 20000

Show all
Copy parameter's URL ImageWidth Image width
Optional

Integer Image width in pixels.

Range: 10 .. 20000

Show all
Copy parameter's URL TextAntialiasing Text antialiasing
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

Show all
Copy parameter's URL GraphicsAntialiasing Graphics antialiasing
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

Show all
Copy parameter's URL ImageInterpolation Image interpolation
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

Show all
Copy parameter's URL UseCIEColor Use CIE Color
Optional

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

Default: False

Show all

Show parameters

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 JavaScript Client

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

For conversions with the multiple file result please refer to the example