Description
n8n-nodes-deepread
This is an n8n community node for DeepRead — AI-native document processing with two engines: Extract (one OCR pass) and Deep Extract (two OCR passes, an LLM judge and a second read that checks each extracted field value).
n8n is a fair-code licensed workflow automation platform.
Installation
Operations
Credentials
Compatibility
Usage
Resources
Installation
Follow the installation guide in the n8n community nodes documentation.
Quick install in n8n:
1. Go to Settings → Community Nodes
2. Click Install
3. Enter n8n-nodes-deepread
4. Click Install
Operations
The DeepRead node supports four operations, all powered by the same DeepRead API:
OCR Extract
Extract text from any PDF or image. Returns the raw extracted text, plus a preview URL for the document when the Preview option is on.
Accepted uploads depend on the plan: PDF, PNG and JPEG on Free; TIFF, WebP, BMP, GIF, DOCX and TXT from Standard; office, spreadsheet and HTML formats on Enterprise. Anything that is not a PDF, PNG or JPEG is converted to PDF before the page count, and the page count is what is charged.
Structured Extraction
Extract typed JSON fields from documents using a custom JSON Schema. The node outputs the full job response. Extracted fields live in the extraction.fields array ($json.extraction.fields), where each field is an object:
key— the field name from your schema (e.g.invoice_number)value— the extracted value (scalar, object, or array)needs_review—trueif the field needs human reviewreviewreason— explanation when flagged (present only whenneedsreviewistrue)location.page— page number the value was found on- Plan Default — omits the field: Free and Standard plans run Extract, Enterprise plans run Deep Extract
- Extract — one OCR pass: Markdown, layout and bounding boxes, plus your fields when you send a schema
- Deep Extract — two OCR passes, an LLM judge and a second read that checks each extracted field value
- Idempotency Key — a retry with the same key returns the job the first request created instead of a second one; a different request with the same key is refused with
409 - Incognito (Enterprise) — the document is encrypted with a single-use key and crypto-shredded the moment the job finishes. No preview link, no field locations; cannot be combined with Searchable PDF
- Preview (default off) — page images, a public preview link and the location of each extracted value on the document. Anyone with the link can open the document, so it exists only when you turn this on
- Retention (Days) (Enterprise, 1–365) — the document, preview artifacts and extracted results are deleted that many days after submission
filledformurl— URL to the filled PDFfields_detected— total fields foundfields_filled— fields successfully filledfieldshilflagged— fields needing review- Names, SSNs, credit cards, emails, phones, addresses
- IPs, DOB, passport numbers, driver’s licenses
- Bank accounts, IBANs, URLs, medical record numbers
- Tested with n8n 1.0+
- Works in self-hosted and cloud n8n
- Compatible with all standard n8n agent integrations (use as a tool in AI Agent nodes)
Use this for invoices, receipts, contracts, medical records, insurance claims — any document where you need specific fields.
Engine and options (OCR Extract and Structured Extraction)
Engine picks how the document is processed and is sent as the API’s pipeline field:
Every job reports its product (extract or deep-extract) and the pipeline you asked for. The older names fast and standard still work as aliases for extract and deep-extract.
Searchable PDF also returns a searchable/selectable PDF as a binary output (searchablePdf). It is a Deep Extract add-on on Enterprise plans; the Extract engine does not support it.
Options (add the ones you need):
A feature the plan does not include is refused with 402 and a body naming the plan that has it.
Form Fill
Fill any PDF form (including scanned, non-editable forms) with your data. AI visually detects fields, semantically maps your JSON data, fills the form, and quality-checks the result. Returns the filled PDF as a binary attachment.
Returns:
PII Redact
Detect and redact 14 types of PII with irreversible black bars, built for HIPAA/GDPR redaction workflows:
Returns the redacted PDF as a binary attachment plus a detection report by PII type.
Supports 5 languages: English, Chinese, Spanish, Hindi, Arabic.
Credentials
You need a DeepRead API key:
1. Sign up at deepread.tech/dashboard (free, no credit card)
2. Get your API key
3. In n8n, create a new DeepRead API credential
4. Paste your API key (starts with sklive...)
5. Click Test to verify
Free: 2,000 pages a month, resetting on the day you signed up
Standard: prepaid credits from $15 per 1,000 pages — Extract $15, Deep Extract $35
Enterprise: custom
BYOK: Connect your own OpenAI/Google/OpenRouter key at deepread.tech/dashboard/byok for zero DeepRead LLM costs and unlimited pages
Compatibility
Usage
Example: Auto-process invoices from email
[Gmail Trigger] → [DeepRead: Structured Extraction] → [Google Sheets]
Schema: vendor, total, due_date
Example: Redact PII before LLM processing
[File Upload] → [DeepRead: PII Redact] → [OpenAI: Analyze]
Example: Auto-fill onboarding forms
[Webhook] → [DeepRead: Form Fill] → [Email: Send filled PDF]
Form fields: full_name, dob, ssn, address
The node handles all async polling automatically — submit a document, get the result back. No need to manage job IDs or polling logic.
Webhooks
If you call the API directly instead, webhook_url (Standard plans and up) delivers the same job payload once the job finishes. Every delivery is signed with X-DeepRead-Signature (t=, an HMAC-SHA256 over GET /dashboard/v1/webhooks/secret.
Resources
Version history
0.3.0
pipeline field0.1.2
{code, message} objects
