API

Table of Contents

Introduction

• Getting Started
  • API Reference
  • Authenticating Your API Request
  • Response codes
  • Sample Code
• Understanding Sync and Async Modes
  • What are Sync and Async Modes?
  • Why Async Mode is Superior
  • How to Switch to Async Mode
  • Conclusion
  • Addressing Common Concerns

Extraction

• AI Invoice Parser
  • Available Methods
  • /ai-invoice-parser
  • Invoice Schema
  • Setting up the Callback URL
  • Code samples
• Document Parser
  • Built-in document parser templates
  • How to classify incoming documents before parsing them?
  • Additional Information and Tools
  • Available Methods
  • /pdf/documentparser
  • /pdf/documentparser/templates
  • /pdf/documentparser/templates/:id
  • Code samples
  • Template samples
• Extract Attachments
  • Available Methods
  • /pdf/attachments/extract
  • Code samples

Editing

• PDF Add
  • Available Methods
  • /pdf/edit/add
  • Available fonts
  • Code samples
• PDF Search and Replace Text
  • Available Methods
  • /pdf/edit/replace-text
  • /pdf/edit/replace-text-with-image
• PDF Search and Delete Text
  • Available Methods
  • /pdf/edit/delete-text
  • Code samples

Conversion

• PDF to CSV
  • Available Methods
  • /pdf/convert/to/csv
  • Code samples
• PDF to JSON
  • Available Methods
  • /pdf/convert/to/json2
  • /pdf/convert/to/json-meta
  • Code samples
• PDF to Text
  • Available Methods
  • /pdf/convert/to/text
  • /pdf/convert/to/text-simple
  • Code samples
• PDF to Excel
  • Available Methods
  • /pdf/convert/to/xls
  • /pdf/convert/to/xlsx
  • Code samples (PDF to XLS)
  • Code samples (PDF to XLSX)
• PDF to XML
  • Available Methods
  • /pdf/convert/to/xml
  • Code samples
• PDF to HTML
  • Available Methods
  • /pdf/convert/to/html
  • Code samples
• PDF to Image
  • Available Methods
  • /pdf/convert/to/jpg
  • /pdf/convert/to/png
  • /pdf/convert/to/webp
  • /pdf/convert/to/tiff
  • Code samples
• PDF from Document
  • Available Methods
  • /pdf/convert/from/doc
  • /pdf/convert/from/csv
  • Code samples
• PDF from Image
  • Available Methods
  • /pdf/convert/from/image
  • Code samples
• PDF from URL
  • Available Methods
  • /pdf/convert/from/url
  • Code samples
• PDF from HTML
  • Available Methods
  • /pdf/convert/from/html
  • Code samples
• PDF from HTML Template
  • Available Methods
  • /templates/html
  • /templates/html/:id
  • Code samples
  • Template Samples
• PDF from Email
  • Available Methods
  • /pdf/convert/from/email
  • Code samples
• Convert Excel
  • Available Methods
  • /xls/convert/to/csv
  • /xls/convert/to/json
  • /xls/convert/to/html
  • /xls/convert/to/txt
  • /xls/convert/to/xml
  • /xls/convert/to/pdf
  • Code samples (XLS to CSV)
  • Code samples (XLS to XML)

Merging & Splitting

• PDF Merge
  • Available Methods
  • /pdf/merge
  • /pdf/merge2
  • Code samples (/pdf/merge)
  • Code samples (/pdf/merge2)
• PDF Split
  • Available Methods
  • /pdf/split/
  • /pdf/split2/
  • Code samples

Forms

• PDF Forms Info Reader
  • Available Methods
  • /pdf/info/fields
  • Code samples
• PDF Filler
  • Create Fillable PDF Forms
  • Fill PDF Forms
  • Code samples

Find & Search

• PDF Find
  • Available Methods
  • /pdf-find
  • /pdf-find-table
• PDF Make Text Searchable or Unsearchable
  • Available Methods
  • /pdf/makesearchable
  • /pdf/makeunsearchable

Pages

• PDF Delete Pages
  • Available Methods
  • /pdf/edit/delete-pages
  • Code samples
• PDF Rotate Pages
  • Available Methods
  • /pdf/edit/rotate
  • /pdf/edit/rotate/auto
  • Code samples (/pdf/edit/rotate)
  • Code samples (/pdf/edit/rotate/auto)

Document, File & System

• Document Classifier
  • Auto classification Of Incoming Documents
  • Available Methods
  • /pdf/classifier
  • Code samples
• File Upload
  • Temporary Files Upload
  • Steps to Upload File
  • Response Codes
  • Available Methods
  • /file/upload/get-presigned-url
  • /presignedUrl –data-binary ‘sample.pdf’
  • /file/upload
  • /file/upload/base64
  • /file/upload/url
  • /file/upload/url
  • /file/delete
  • /file/hash
• PDF Info Reader
  • Available Methods
  • /pdf/info
  • Code samples
• PDF Optimize
  • Available Methods
  • /pdf/optimize
  • Code samples
• Email Send and Decode
  • Available Methods
  • /email/send
  • /email/decode
  • /email/extract-attachments
  • Code samples
• Background Job Check
  • Available Methods
  • /job/check
  • Code samples
• Account Info
  • Available Methods
  • /account/credit/balance
• Add / Remove PDF Password & Security
  • Available Methods
  • /pdf/security/add
  • /pdf/security/remove
  • Code samples
• Data Encryption & Decryption
  • Popular Use Cases
  • Read Custom Encrypted PDF
  • Custom encrypted Docx to PDF
  • Read QR Code From Encrypted PNG
  • PDF Encrypted by SalesForce with AES128 To JPG
  • Merge PDFs encrypted by SalesForce to new PDF encrypted for SalesForce

Barcodes

• Barcode Generator
  • Available Methods
  • /barcode/generate
  • QRCode Example
  • QRCode with Logo Inside Example
  • Data URI as Output Example
  • Code samples
• Barcode Reader
  • Available Methods
  • /barcode/read/from/url
  • Optical Marks Reader
  • Code samples

Security

• Overview of PDF.co API Security Features
  • Introduction
  • PDF.co API Security Features
  • Data Transmission
  • Data Encryption
  • Data Security
  • Physical Security
  • Security Frameworks
• User-Controlled Encryption
  • User-controlled encryption of input files and decryption of output files

Glossary

• Postman
  • Getting Started with Postman & PDF.co
• Webhooks & Callbacks
  • What are Callbacks?
  • What are Webhooks?
  • PDF.co & Webhooks
  • Summary
• Profiles
  • Sample Code
  • Generic Profile Options
  • Profile Options by Endpoint
• Response Codes

Was this page helpful? Yes No

Are you a human?

Close

---

This website uses cookies for functional and analytical purposes. By continuing, you agree to our cookie use. Please read our  privacy policy  for more information.

I Agree