TXT to JPG API

The API for converting Text file documents to JPG images.

TXT JPG

The API for converting text file TXT documents to JPG files.

Copy parameter's URL Secret Secret
Type: String

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

Show all
Copy parameter's URL Token Token
Type: 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
Type: File

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

Show all
Copy parameter's URL StoreFile Store file
Type: Bool

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

Default: False Show all
Copy parameter's URL FileName File name
Type: String

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

Show all
Copy parameter's URL Timeout Timeout
Type: Integer

Conversion timeout in seconds.

Default: 900 Range: 10 .. 1200 Show all
Copy parameter's URL ImageResolutionH Horizontal image resolution
Type: Integer

Set output image horizontal resolution in dpi.

Default: 200 Range: 1 .. 3000 Show all
Copy parameter's URL ImageResolutionV Vertical image resolution
Type: Integer

Set output image vertical resolution in dpi.

Default: 200 Range: 1 .. 3000 Show all
Copy parameter's URL ScaleImage Scale image
Type: 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
Type: Bool

Constrain proportions when scaling the output image.

Default: True Show all
Copy parameter's URL ScaleIfLarger Scale if larger
Type: Bool

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

Default: False Show all
Copy parameter's URL ImageHeight Image height
Type: Integer

Image height in pixels.

Range: 10 .. 20000 Show all
Copy parameter's URL ImageWidth Image width
Type: Integer

Image width in pixels.

Range: 10 .. 20000 Show all
Copy parameter's URL TextAntialiasing Text antialiasing
Type: 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
Type: 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
Type: 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
Type: Bool

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

Default: False Show all
Copy parameter's URL PageRange Page Range
Type: String

Set page range.

Default: 1-2000 Show all
Copy parameter's URL PageOrientation Page orientation
Type: Collection

Page orientation.

Default: default Values: default portrait landscape Show all
Copy parameter's URL PageSize Page size
Type: 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 OpenFormat Open Format
Type: Collection

Specifies the format to use when opening a document.

Default: auto Values: auto word rtf unencoded unicode Show all
Copy parameter's URL TextAlign Text Align
Type: Collection

Specifies how the parser should align text.

Default: left Values: left center right justify Show all
Copy parameter's URL TextEncoding Text Encoding
Type: Collection

Specifies what encoding the parser should use when converting text files.

Default: auto Values: auto arabicasmo baltic centraleuropean cyrillic europa extalphalowercase greek hebrew hzgbsimplifiedchinese german japaneseshiftjis koi8r koi8u korean thai turkish unicodebigendian unicodelittleendian usascii utf7 utf8 vietnamese western Show all
Copy parameter's URL JpgType JPG Type
Type: Collection

Set JPG type.

Default: jpeg Values: jpeg jpegcmyk jpeggray Show all
Copy parameter's URL ImageQuality Output image quality
Type: Integer

Set output image quality.

Default: 75 Range: 10 .. 100 Show all

Code snippet

// Code snippet is using the ConvertAPI JavaScript Client: https://github.com/ConvertAPI/convertapi-js

// Code snippet is using the ConvertAPI Node.js Client: https://github.com/ConvertAPI/convertapi-nodejs

// Code snippet is using the ConvertAPI PHP Client: https://github.com/ConvertAPI/convertapi-php

// Code snippet is using the ConvertAPI Java Client: https://github.com/ConvertAPI/convertapi-java

// Code snippet is using the ConvertAPI C# Client: https://github.com/ConvertAPI/convertapi-dotnet

# Code snippet is using the ConvertAPI Ruby Client: https://github.com/ConvertAPI/convertapi-ruby

# Code snippet is using the ConvertAPI Python Client: https://github.com/ConvertAPI/convertapi-python

// Code snippet is using the ConvertAPI Go Client: https://github.com/ConvertAPI/convertapi-go

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

<!-- For conversions with the multiple file result please refer to this example: https://repl.it/@ConvertAPI/HTML-Form-with-multiple-file-result -->