Properties
| Name | Type | Summary |
| Authentication |
|
›
ApiKey
|
integer
| API Key should be passed if you purchased membership with credits. Please login to your control panel to find out your API Key http://www.convertapi.com/control-panel |
| Conversion Parameters |
|
›
Timeout
= 300
|
integer
| Conversion timeout in seconds. The minimum value is 5 seconds and maximum is 600 seconds (10 minutes) |
|
›
AlternativeParser
= false
|
boolean
| If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion. The option process files much slower and should be disabled by default. |
|
›
OutputFormat
= pdf
|
string (collention)
pdf - portable document formatpdfa - portable document format specialized for the digital preservation of electronic documents.png - png image.jpg - jpg image.tif - tiff image.
| Set the output file format. The default output format is Pdf. If output format is set to Png or Jpg a image file will be created for every converted document page and returned as zip file. |
|
›
InputFormat
|
string (collention)
avs - AVS X imagebmp - OS/2 Bitmap or MS Windows Bitmap imagedcx - IBM PC multi-page Paintbrushdib - MS Windows Device Independent Bitmapdpx - Digital Moving Picture Exchangefax - Group 3 FAX encodingfits - Flexible Image Transport Systemfpx - FlashPix Formatgif - CompuServe graphics interchange formatico - OS/2 or MS Windows Iconsiptc - Newswire profilejbig - Joint Bi-level Image experts Group interchange formatjp2 - JPEG-2000 JP2 File Format Syntaxjpeg - Joint Photographic Experts Group JFIF formatjpg - Joint Photographic Experts Group JFIF formatmdi - MS Office Document Imagingmiff - Magick image formatmng - Multiple-image Network Graphicsmpc - Magick Persistent Cache image formatmtv - MTV Raytracing image formatotb - On-the-air Bitmappbm - Portable Bitmappcd - Kodak PhotoCD - Base/16, Base/4 and Base onlypcds - Kodak PhotoCD - Base/16, Base/4 and Base onlypct - MacIntosh PICTpcx - PC PaintBrushpgm - Portable GrayMappict - Apple Macintosh QuickDrawpng - Portable Network Graphicspnm - Portable Any Bitmapppm - Portable PixelMappsd - Adobe Photoshopp7 - Xv visual schnauzer formatras - Raster Sun Microsystemsrgba - Raw red, green, blue, and matte samplessun - Raster SunMicrosystemstga - TrueVision Targatiff - Tagged Interchange Formatvicar - V.I.C.A.R. Image formatvid - Visual Image Directoryviff - Khoros Visualization imagewmf - Windows Meta Filexbm - X Windows system bitmap, black and white onlyxpm - X Windows system pixmap file (color)xwd - X Windows system window dump file (color)
| The supported source file formats. In most cases you don't need to set up this parameter because input file format will be detected from submited file name automatically. |
| Credits Information |
|
‹
CreditsLeft
|
integer
| Return number of remaining credits. Only available when ApiKey is provided. |
|
‹
CreditsCost
= 2
|
integer
| The cost of credits for one conversion. |
| Output Result |
|
‹
Result
|
boolean
| Conversion result. Return True if conversion successful, otherwise False. |
|
‹
Error
|
string
| Contain information about conversion failure. Only available when Result = False. |
|
‹
FileSize
|
integer
| Converted file size in bytes. |
|
›
StoreFile
= false
|
boolean
| Store file on server and return url to file instead of file stream response. File will be available for 24 hours. |
|
‹
FileUrl
|
string
| Converted file url to download from a server. Only available when StoreFile = True. |
|
‹
File
|
bytes
| If JSon object is used as output then a file will be encoded using Base64 encoding. |
|
›
OutputFileName
|
string
| Converted output file name. If parameter is not set the filename will be generated automatically. |
| PDF Options |
|
›
DocumentTitle
|
string
| Set the title of the generated Pdf file. If value is not set a source document title is used instead. |
|
›
DocumentSubject
|
string
| Set the subject of the generated Pdf file. If value is not set a source document subject is used instead. |
|
›
DocumentAuthor
|
string
| Set the author of the generated Pdf file. If value is not set a source document author is used instead. |
|
›
DocumentKeywords
|
string
| Set the keywords of the generated Pdf file. If value is not set a source document keywords is used instead. |