PDF.co Web API (Application Programming Interface)

Get Your Free API Key

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

types
optional

Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.

  • Must be a String

file
optional

Source barcodes file.

url
optional

URL of the image to decode barcodes from.

  • Must be a String

pages
optional

Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: “0,2-5,7-”.

  • Must be a String