@ujiboo/n8n-nodes-monk
v0.1.1
Published
n8n community node for Monk Document Extraction API integration
Readme
@ujiboo/n8n-nodes-monk
Simple n8n nodes for the Monk Document Extraction API:
- Monk Upload Document – upload a file to Monk
- Monk Document Processed Trigger – poll Monk for newly processed documents
Installation
n8n Cloud
- Go to Settings → Community Nodes
- Click Install a community node
- Enter
@ujiboo/n8n-nodes-monk
Self‑hosted n8n
npm install @ujiboo/n8n-nodes-monkRestart n8n after installing.
Credentials
Add a Monk API credential in n8n:
- API Key – your Monk API key
- Base URL – Monk API base (defaults to
https://monk.ujiboo.com/api/v1)
These credentials are reused by all nodes in this package.
Nodes
Monk Upload Document
Uploads a single PDF or image (JPEG/PNG) to Monk using the documents/init-upload flow.
Key options:
- Operation
- Upload Document (No Wait) – upload and return immediately
- Upload Document and Wait for Result – upload, wait for processing, then return documents
- Input Data Field Name – name of the JSON or binary field that contains the file
- File Name – optional override for the uploaded file name
- Extractor ID / Extraction Configuration – optional Monk extraction settings
- Maximum Wait Time / Poll Interval (only for Upload and Wait) – control how long and how often the node polls Monk
Output:
- Upload (No Wait) – one item with
documentId,documentSourceId,tempKey,uploadId,fileName,fileType,fileSize,uploadedAt - Upload and Wait – one item per processed document; document JSON at the top level plus
_metawith upload info and stats
Monk Document Processed Trigger
Polls Monk’s /documents endpoint and emits only new documents since the workflow started.
Key options:
- Poll Interval (Minutes) – how often to query Monk
- Items Per Page – how many documents to fetch per poll
- Emit Mode
- Single Document Per Execution – one execution per document
- Batch (All New Documents) – all new documents in one execution
- Verified Filter – all / verified / unverified
- Upload ID Filter – only documents for a specific
upload_id - Status Filter – all / completed / failed / processing (based on the document status)
- Include Document Data – include or omit the extracted
datapayload
Each emitted item contains document metadata plus:
_triggeredAt– when this poll ran_serverEnvironment–credentialsorcustom
Development
- Install dependencies:
npm install - Build:
npm run build - Lint:
npm run lint
The GitHub Action in .github/workflows/publish.yml builds, lints, and publishes the package to npm on tagged releases.
License
MIT – see LICENSE.md.
