PDF.co Web API (Application Programming Interface)


Benefits:

  • Security: API runs on the secure Amazon AWS infrastructure. All data transfers are encrypted by SSL/TLS encryption;
  • You may also use this API via Zapier plugin or as offline on-premise SDK on your own server
  • API uses so called credits from your account which are reduced for every call and for every page. For example, converting PDF with 2 pages requires 3 credits (1 for transformation, 2 for pages)

How to use with input URL:
  1. Call any method with url param set to your input URL
  2. The method returns JSON with URL to the generated file. Use inline for methods like pdf/to/text if you want to get generated content as a response.
How to use with files:
  1. Call any method and set file param to your file
  2. The method returns JSON with URL to the generated file. Use inline for methods like pdf/to/text if you want to get generated content as a response.
How to use async mode with large files or urls:
  1. Request a temporary URL using /file/upload/get-presigned-url.
  2. Upload your file using POST to this URL
  3. Call method to transform using the URL from previous steps. Set async param to true so the transformation will run in async mode and will return output URL and the jobId immediately.
  4. Check the status of the jobId and once it returns Finished status, you may use the output URL to download the result.

Need help? Explore Source Code Samples on Github or click here to contact our dedicated API support team. Or send email to pdfco@bytescout.zendesk.com and we will be in touch.

Get Your Free API Key

Resources

Generate and Decode Barcodes

Resource Description
  GET/POST - https://api.pdf.co/v1/barcode/generate Generate high quality printable and scannable barcodes as images or PDF. All popular types are supported from Code 39, Code 128 to QR Code, Datamatrix and PDF417.
  GET/POST - https://api.pdf.co/v1/barcode/read/from/url Read barcodes from images, tiff, pdf documents, scanned documents. All popular types of barcodes are supported from Code 39, Code 128 to QR Code, Datamatrix and PDF417. Supports noisy and damaged barcodes, scans, documents.

Create PDF and Convert to PDF

Resource Description
  GET/POST - https://api.pdf.co/v1/xls/convert/to/pdf Convert XLS, XLSX, CSV spreadsheets into PDF
  GET/POST - https://api.pdf.co/v1/pdf/convert/from/csv Convert CSV, XLS, XLSX to PDF conversion.
  GET/POST - https://api.pdf.co/v1/pdf/convert/from/doc Convert DOC, DOCX, RTF, TXT, XPS files into PDF.
  GET/POST - https://api.pdf.co/v1/pdf/convert/from/html Convert HTML code snippet into full featured PDF.
  GET/POST - https://api.pdf.co/v1/pdf/convert/from/image Create PDF file from one or more JPG, PNG, TIF images.
  GET/POST - https://api.pdf.co/v1/pdf/convert/from/url Create a rich PDF copy of a website by passing URL link to the source.

Document templates

Resource Description
  GET - https://api.pdf.co/v1/templates Document templates list for current user
  GET - https://api.pdf.co/v1/templates/:id Document template information
  POST - https://api.pdf.co/v1/templates/:id/use Create and send document from document template

Documents

Resource Description
  GET - https://api.pdf.co/v1/documents Get all current user's documents data
  GET - https://api.pdf.co/v1/documents/:id Get document data

Upload Files and Documents

Resource Description
  GET - https://api.pdf.co/v1/file/upload/get-presigned-url FOR LARGE FILES UPLOADING: Get preassigned URL, upload your file using POST to this url, use this URL with API methods. Temporary files are automatically permanently removed after 1 hour.
  GET/POST - https://api.pdf.co/v1/file/upload/url Downloads file from a source url and uploads it as a temporary file. Temporary files are automatically permanently removed after 1 hour.
  GET/POST - https://api.pdf.co/v1/file/upload/url Uploads file as a temporary file. Temporary files are automatically permanently removed after 1 hour.
  POST - https://api.pdf.co/v1/file/upload/base64 Creates temporary file using base64 source data. You may use this temporary file URL with other API methods. Temporary files are automatically permanently removed after 1 hour.
  GET/POST - https://api.pdf.co/v1/file/hash Calculate and return MD5 hash of file by url. Commonly used to control if source document has been changed or not because every little change will cause hash string to differ as well.

Asynchronous Jobs Status Check

Resource Description
  GET/POST - https://api.pdf.co/v1/job/check Checks and returns status of a job that is running in background. Returns "InProgress", "Failed", "Aborted", "Finished"

Invoice Parsing and Document Parsing

Resource Description
  GET/POST - https://api.pdf.co/v1/pdf/documentparser Parses and gets data from document using previously prepared template
  GET/POST - https://api.pdf.co/v1/pdf/invoiceparser Automatically parses PDF, PNG, JPG invoices, detects a company name and returns date, invoice id, total amount.

PDF Tools

Resource Description
  GET/POST - https://api.pdf.co/v1/pdf/merge Merges two PDF documents.
  GET/POST - https://api.pdf.co/v1/pdf/optimize Optimizes existing PDF file to reduce its file size
  GET/POST - https://api.pdf.co/v1/pdf/split Split PDF document.
  GET/POST - https://api.pdf.co/v1/pdf/info Gets PDF document information.
  GET/POST - https://api.pdf.co/v1/pdf/find

Data Extraction From Documents and Scans

Resource Description
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/csv Extracts data from PDF, PNG, JPG to CSV. Automatically preserves the original layout of tables, rows, columns.
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/html PDF, PDF, PNG, JPG to HTML conversion. Automatically preserves the original visual layout, vectors, images, formatting.
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/json Extracts data from PDF to JSON. Automatically preserves the original layout of tables, rows, columns. Includes information about coordinates, fonts, font size and styles.
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/text PDF, PNG, JPG to TEXT conversion. Automatically preserves the original text layout. Restores damaged and scanned text.
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/xls PDF, PNG, JPG to XLS conversion. Automatically preserves the original layout of tables, rows, columns, font styles, font size, colors
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/xlsx PDF, PNG, JPG to XLSX conversion. Automatically preserves the original layout of tables, rows, columns, font styles, font size, colors
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/xml PDF, PNG, JPG to XML conversion. Automatically preserves the original layout of tables, rows, columns. Includes information about coordinates, fonts, font size and styles.

Edit and Modify PDF Documents

Resource Description
  GET/POST - https://api.pdf.co/v1/pdf/makesearchable Turns scanned pdf file into text searchable pdf file
  GET - https://api.pdf.co/v1/pdf/sign E-sign PDF document with visual signature, text, also adds e-signature certificate.
  POST - https://api.pdf.co/v1/pdf/sign E-sign PDF document with visual signature, text, also adds e-signature certificate.
  GET/POST - https://api.pdf.co/v1/pdf/edit/add Adds text and images to existing pdf file

PDF Rendering and Preview Generation

Resource Description
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/jpg PDF to JPEG conversion. High quality rendering. Also works great for thumbnails generation and previews.
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/png PDF to PNG conversion. High quality rendering. Also works great for thumbnails generation and previews.
  GET/POST - https://api.pdf.co/v1/pdf/convert/to/tiff PDF to high quality TIFF images conversion. High quality rendering. Also works great for thumbnails generation and previews.

Generate an image preview of a website

Resource Description
  GET/POST - https://api.pdf.co/v1/url/convert/to/jpg Create high-quality JPEG screenshot of web page using its URL
  GET/POST - https://api.pdf.co/v1/url/convert/to/png Create high-quality PNG screenshot of web page using its URL

Actions with Spreadsheets

Resource Description
  GET/POST - https://api.pdf.co/v1/xls/convert/to/csv Convert XLS into CSV comma separated values file
  GET/POST - https://api.pdf.co/v1/xls/convert/to/html Convert XLS into HTML
  GET/POST - https://api.pdf.co/v1/xls/convert/to/json Convert XLS into JSON data file