PDF.co Web API v.1.00

NOTE: This documentation applies to both PDF.co and on-prem version ByteScout API Server. Remarks in the documentation highlighting a difference if any.

• PDF.co Platform Benefits
• 3rd Party Platforms Integrations
• Developers: explore 100+ Source Code Samples
• Tech Support From Engineers
• Explore PDF.co API Knowledgebase

Not a developer and looking for free apps? Check 100% free apps at PDFLite.co

Indices

• Document Parser
  • [POST] /pdf/documentparser (output as JSON)
  • [POST] /pdf/documentparser (output as XML)
  • [POST] /pdf/documentparser (output as CSV)
  • [POST] /pdf/documentparser (output as JSON, custom template code)
  • [GET] /pdf/documentparser/templates
  • [GET] /pdf/documentparser/templates/:id
• Document Classifier
  • [POST] /pdf/classifier
• Email Send and Decode
  • [POST] /email/send
  • [POST] /email/decode
  • [POST] /email/extract-attachments
• PDF Info Reader
  • [POST] /pdf/info
• PDF Forms Info Reader
  • [POST] /pdf/info/fields
• PDF Attachments
  • [POST] /pdf/attachments/extract
• PDF Add Text, Signatures and Images to PDF
  • [POST] /pdf/edit/add (adding text and images)
  • [POST] /pdf/edit/add (adding watermarks)
  • [POST] /pdf/edit/add (adding text and images with simplified parameters)
• PDF Fill PDF Forms
  • [POST] /pdf/edit/add (fill pdf form)
  • [POST] /pdf/edit/add (fill pdf form with simplified params)
• PDF Create Fillable PDF Forms
  • [POST] /pdf/edit/add (create pdf fields)
• PDF Search Text
  • [POST] /pdf/find
• PDF Find Table
  • [POST] /pdf/find/table (AI powered)
  • [POST] /pdf/find/table (legacy table finder)
• PDF Search and Replace Text
  • [POST] /pdf/edit/replace-text (multiple replacements)
  • [POST] /pdf/edit/replace-text (single replacement)
• PDF Search and Replace Text with Image
  • [POST] /pdf/edit/replace-text-with-image
  • [POST] /pdf/edit/replace-text-with-image (datauri)
• PDF Search and Delete Text from PDF
  • [POST] /pdf/edit/delete-text (single replacement)
  • [POST] /pdf/edit/delete-text (delete and draw color)
  • [POST] /pdf/edit/delete-text (multiple replacements)
• PDF Make Text Searchable or Unsearchable
  • [POST] /pdf/makesearchable (Scanned PDF to Text Searchable PDF)
  • [POST] /pdf/makesearchable (PNG to Text Searchable PDF)
  • [POST] /pdf/makesearchable (JPG to Text Searchable PDF)
  • [POST] /pdf/makesearchable (TIF to Text Searchable PDF)
  • [POST] /pdf/makeunsearchable (PDF to Scanned PDF)
• PDF To CSV
  • [POST] /pdf/convert/to/csv
• PDF To JSON
  • [POST] /pdf/convert/to/json2
  • [POST] /pdf/convert/to/json-meta (AI powered)
• PDF To TEXT
  • [POST] /pdf/convert/to/text (with layout and ocr)
  • [POST] /pdf/convert/to/text-simple (no layout and ocr, cheaper and faster)
• PDF To XLS
  • [POST] /pdf/convert/to/xls (xls output)
• PDF To XLSX
  • [POST] /pdf/convert/to/xls (xlsx output)
• PDF To XML
  • [POST] /pdf/convert/to/xml
• PDF to HTML
  • [POST] /pdf/convert/to/html
• PDF to JPG
  • [POST] /pdf/convert/to/jpg
• PDF to PNG
  • [POST] /pdf/convert/to/png
• PDF to WEBP
  • [POST] /pdf/convert/to/webp
• PDF to TIFF
  • [POST] /pdf/convert/to/tiff
• PDF from CSV (CSV to PDF)
  • [POST] /pdf/convert/from/csv
• PDF from Doc, DocX, RTF, TXT, XPS (Document to PDF)
  • [POST] /pdf/convert/from/doc
• PDF from URL (URL to PDF)
  • [POST] /pdf/convert/from/url
• PDF from HTML (HTML to PDF)
  • [POST] /pdf/convert/from/html (raw html input)
  • [POST] /pdf/convert/from/html (with custom profiles and custom js to disable links)
• PDF from HTML Template
  • [POST] /pdf/convert/from/html (json input)
  • [POST] /pdf/convert/from/html (csv input)
  • [POST] /pdf/convert/from/html (advanced template with auto calc)
  • [POST] /pdf/convert/from/html (multi page invoice with qr code and auto calc)
  • [GET] /templates/html
  • [GET] /templates/html/:id
• PDF from Email
  • [POST] /pdf/convert/from/email
  • [POST] /pdf/convert/from/email (with orientation and paper size)
• PDF from Images (JPG to PDF and PNG to PDF)
  • [POST] /pdf/convert/from/image
• PDF from XLS or CSV
  • [POST] /xls/convert/to/pdf
• PDF Split
  • [POST] /pdf/split (split by page index)
• PDF Split By Text Search
  • [POST] /pdf/split2 (split by text search)
• PDF Split By Barcode
  • [POST] /pdf/split2 (split by barcode)
• PDF Merge
  • [POST] /pdf/merge
• PDF Merge From Anything
  • [POST] /pdf/merge2 (supports zip, doc, rtf, xls, png, jpg etc)
• PDF Password And Security
  • [POST] /pdf/security/add
  • [POST] /pdf/security/remove
• User Controlled Data Encryption and Decryption
  • [POST] Read Custom Encrypted PDF
  • [POST] Custom encrypted Docx to PDF
  • [POST] Read QR Code From Encrypted PNG
  • [POST] PDF Encrypted by SalesForce with AES128 To JPG
  • [POST] Merge PDFs encrypted by SalesForce to new PDF encrypted for SalesForce
• PDF Rotate Pages
  • [POST] /pdf/edit/rotate
  • [POST] /pdf/edit/rotate/auto
• PDF Delete Pages
  • [POST] /pdf/edit/delete-pages
• PDF Compress and Optimize
  • [POST] /pdf/optimize
• XLS / XLSX to CSV
  • [POST] /xls/convert/to/csv
• XLS/XLSX to JSON
  • [POST] /xls/convert/to/json
• XLS/XLSX to HTML
  • [POST] /xls/convert/to/html
• XLS/XLSX to TXT
  • [POST] /xls/convert/to/txt
• XLS/XLSX to XML
  • [POST] /xls/convert/to/xml
• Barcode Generator
  • [POST] /barcode/generate
  • [POST] /barcode/generate (qr code)
  • [POST] /barcode/generate (qr code with logo inside)
  • [POST] /barcode/generate (datauri as output)
• Barcode Reader
  • [POST] /barcode/read/from/url
  • [POST] /barcode/read/from/url (read qr code)
• Optical Marks Reader (Checkboxes, Radiobutton, Fillable Fields, Segments etc)
  • [POST] /barcode/read/from/url (find checkboxes on scan image)
• Background Jobs Check
  • [POST] /job/check
• Upload Files
  • [GET] /file/upload/get-presigned-url (GET generate secure URL for upload)
  • [PUT] PUT presignedUrl –data-binary ‘sample.pdf’
  • [POST] /file/upload (Uploading small file)
  • [POST] /file/upload/base64 (Upload small file as Base64)
  • [POST] /file/upload/url (Upload file from URL)
  • [GET] /file/upload/url (Upload from URL)
  • [POST] /file/delete
  • [POST] /file/hash
• Misc Account Info And Misc
  • [GET] /account/credit/balance
  • [GET] /license/info (on-prem API Server only)

PDF.co Platform Benefits

• Use from API or via 300+ Integrations: you can use PDF.co from anywhere: programming languages, RPA platforms like UI and Automation Platforms such as Zapier, Integromat, IUPath, RPA apps, SalesForce and many others.
• Security: PDF.co API runs on top of the secure and certified Amazon AWS infrastructure. All data transfers are encrypted by SSL/TLS encryption. See the security page for more details.
• Asynchronous mode is supported so you can process large files and documents with hundreds of pages in the cloud.
• Battle tested by thousands of production users. Our engines are tested in production by thousands of enterprise users.
• Credits based system. For every page credits are consumed from your account. You can purchase non-expiring credits with one-time payments or subscribe for a monthly credits that are cheaper. For the detailed reports explore your API logs.
• On-Prem Version and Private Cloud version is available. Enterprise users may easily switch to ByteScout API Server that can run in a private cloud or on premises. Contact support for more information.

Use From No Code Platforms

We have created plugins most popular automation platforms and RPA including:

• Zapier

• Integromat

• Sharepoint
• SalesForce
• Postman
• Bubble
• UiPath RPA
• BluePrism
• Automation Anywhere
• or explore all 300+ integrations here

Tech Support From Engineers

Our team of engineers is happy to help with the integration, coding of proof of concept projects and any other questions. To contact us please:

• Submit a ticket here (secure online support desk, recommended). You can track all your previous requests here.
• or send email to pdfco@bytescout.zendesk.com