Integration

Paperless-ngx integration

Paperless-ngx is a self-hosted document management system: it consumes scanned files and e-mail attachments, runs OCR on them, and keeps them searchable and organised. This integration covers its REST API: upload a file for consumption, follow the resulting background task, then list, filter and full-text search documents, read one with its OCR content and technical metadata, download its archived PDF, its original file or its thumbnail, update its title, dates, correspondent, document type, storage path, tags and custom fields, add and remove notes, and read its change history. Bulk calls edit, reprocess, rotate, merge, split, trash, email or ZIP-download many documents at once, and the trash calls restore them or empty it. It also manages the taxonomy (correspondents, document types, tags, storage paths, custom fields and saved views), public share links and share-link bundles, IMAP mail accounts and the rules that turn their messages into documents, workflows with their triggers and actions, users, groups and permissions, the instance configuration, background tasks, server logs and instance statistics, and it can ask either the trained classifier or a configured AI provider to suggest how a document should be filed. The host is part of the credential because Paperless-ngx is self-hosted: enter the hostname of your own instance. Authentication is the API token shown in the Paperless-ngx interface under My Profile, sent in the Authorization header with the Token prefix.

Connect Paperless-ngx How integrations work

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in Paperless-ngx.Built from the 155 Paperless-ngx tools below, on the connection you add once.

What you can do with Paperless-ngx

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Document, 23 operations

bulk_download_documentsBulk download documentsPOSTDownload several documents at once as a ZIP archive.
bulk_edit_documentsBulk edit documentsPOSTApply one bulk operation to a list of documents.
delete_documentDelete documentDELETEDelete a document.
delete_document_versionDelete document versionDELETEDelete one stored version of a document.
download_documentDownload documentGETDownload a document's file.
download_document_previewDownload document previewGETDownload the previewable version of a document's file.
download_document_thumbnailDownload document thumbnailGETDownload a document's thumbnail image.
edit_document_pdfEdit document pdfPOSTRun PDF page operations on one document: reorder, delete, rotate or split its pages.
email_documentEmail documentPOSTEmail one document as an attachment.
email_documentsEmail documentsPOSTEmail several documents as attachments to one or more recipients.
get_documentGet documentGETGet one document by id.
get_document_ai_suggestionsGet document ai suggestionsGETAsk the configured AI provider to suggest a title, tags, correspondent, document type and dates for a document.
get_document_metadataGet document metadataGETGet the technical metadata of a document's stored files.
get_document_selection_dataGet document selection dataPOSTCount how the documents in a selection break down by correspondent, tag, document type and storage path.
get_document_suggestionsGet document suggestionsGETGet the classifier's suggested correspondent, tags, document type and storage path for a document.
get_document_version_rootGet document version rootGETGet the first document of the version chain a document belongs to.
get_next_archive_serial_numberGet next archive serial numberGETGet the next free archive serial number (ASN).
list_document_historyList document historyGETList the recorded changes made to a document.
list_documentsList documentsGETList documents.
list_trashed_documentsList trashed documentsGETList the documents currently in the trash.
merge_documentsMerge documentsPOSTMerge several documents into one new document.
remove_document_passwordRemove document passwordPOSTRemove the password protection from an encrypted PDF document.
replace_documentReplace documentPUTReplace a document with a complete new representation.

Mail account, 6 operations

create_mail_accountCreate mail accountPOSTCreate a new mail account.
delete_mail_accountDelete mail accountDELETEDelete a mail account.
get_mail_accountGet mail accountGETGet one mail account by id.
list_mail_accountsList mail accountsGETList mail accounts.
process_mail_accountProcess mail accountPOSTPoll a mail account now instead of waiting for the next scheduled run.
replace_mail_accountReplace mail accountPUTReplace a mail account with a complete new representation.

Share link bundle, 6 operations

create_share_link_bundleCreate share link bundlePOSTCreate a new share link bundle.
delete_share_link_bundleDelete share link bundleDELETEDelete a share link bundle.
get_share_link_bundleGet share link bundleGETGet one share link bundle by id.
list_share_link_bundlesList share link bundlesGETList share link bundles.
rebuild_share_link_bundleRebuild share link bundlePOSTRebuild the archive a share link bundle serves.
replace_share_link_bundleReplace share link bundlePUTReplace a share link bundle with a complete new representation.

Task, 6 operations

acknowledge_tasksAcknowledge tasksPOSTAcknowledge background tasks so they stop being reported as needing attention.
get_taskGet taskGETGet one background task by id.
get_task_status_countsGet task status countsGETCount background tasks by status.
list_active_tasksList active tasksGETList the background tasks currently running or queued.
list_tasksList tasksGETList background tasks.
list_task_summariesList task summariesGETList background tasks in a condensed form.

Correspondent, 5 operations

create_correspondentCreate correspondentPOSTCreate a new correspondent.
delete_correspondentDelete correspondentDELETEDelete a correspondent.
get_correspondentGet correspondentGETGet one correspondent by id.
list_correspondentsList correspondentsGETList correspondents.
replace_correspondentReplace correspondentPUTReplace a correspondent with a complete new representation.

Custom field, 5 operations

create_custom_fieldCreate custom fieldPOSTCreate a new custom field.
delete_custom_fieldDelete custom fieldDELETEDelete a custom field.
get_custom_fieldGet custom fieldGETGet one custom field by id.
list_custom_fieldsList custom fieldsGETList custom fields.
replace_custom_fieldReplace custom fieldPUTReplace a custom field with a complete new representation.

Document type, 5 operations

create_document_typeCreate document typePOSTCreate a new document type.
delete_document_typeDelete document typeDELETEDelete a document type.
get_document_typeGet document typeGETGet one document type by id.
list_document_typesList document typesGETList document types.
replace_document_typeReplace document typePUTReplace a document type with a complete new representation.

Group, 5 operations

create_groupCreate groupPOSTCreate a new group.
delete_groupDelete groupDELETEDelete a group.
get_groupGet groupGETGet one group by id.
list_groupsList groupsGETList groups.
replace_groupReplace groupPUTReplace a group with a complete new representation.

Mail rule, 5 operations

create_mail_ruleCreate mail rulePOSTCreate a new mail rule.
delete_mail_ruleDelete mail ruleDELETEDelete a mail rule.
get_mail_ruleGet mail ruleGETGet one mail rule by id.
list_mail_rulesList mail rulesGETList mail rules.
replace_mail_ruleReplace mail rulePUTReplace a mail rule with a complete new representation.

Saved view, 5 operations

create_saved_viewCreate saved viewPOSTCreate a new saved view.
delete_saved_viewDelete saved viewDELETEDelete a saved view.
get_saved_viewGet saved viewGETGet one saved view by id.
list_saved_viewsList saved viewsGETList saved views.
replace_saved_viewReplace saved viewPUTReplace a saved view with a complete new representation.

Share link, 5 operations

create_share_linkCreate share linkPOSTCreate a new share link.
delete_share_linkDelete share linkDELETEDelete a share link.
get_share_linkGet share linkGETGet one share link by id.
list_document_share_linksList document share linksGETList the public share links that point at a document.
list_share_linksList share linksGETList share links.

User, 5 operations

create_userCreate userPOSTCreate a new user.
deactivate_user_totpDeactivate user totpPOSTTurn off two-factor authentication for a user.
delete_userDelete userDELETEDelete a user.
get_userGet userGETGet one user by id.
list_usersList usersGETList users.

App config, 4 operations

delete_app_configDelete app configDELETEDelete a application configuration.
get_app_configGet app configGETGet one application configuration by id.
list_app_configsList app configsGETList the application configuration objects.
replace_app_configReplace app configPUTReplace a application configuration with a complete new representation.

Storage path, 4 operations

create_storage_pathCreate storage pathPOSTCreate a new storage path.
delete_storage_pathDelete storage pathDELETEDelete a storage path.
get_storage_pathGet storage pathGETGet one storage path by id.
list_storage_pathsList storage pathsGETList storage paths.

Tag, 4 operations

create_tagCreate tagPOSTCreate a new tag.
delete_tagDelete tagDELETEDelete a tag.
get_tagGet tagGETGet one tag by id.
list_tagsList tagsGETList tags.

Workflow, 4 operations

create_workflowCreate workflowPOSTCreate a new workflow.
delete_workflowDelete workflowDELETEDelete a workflow.
get_workflowGet workflowGETGet one workflow by id.
list_workflowsList workflowsGETList workflows.

Workflow action, 4 operations

create_workflow_actionCreate workflow actionPOSTCreate a new workflow action.
delete_workflow_actionDelete workflow actionDELETEDelete a workflow action.
get_workflow_actionGet workflow actionGETGet one workflow action by id.
list_workflow_actionsList workflow actionsGETList workflow actions.

Workflow trigger, 4 operations

create_workflow_triggerCreate workflow triggerPOSTCreate a new workflow trigger.
delete_workflow_triggerDelete workflow triggerDELETEDelete a workflow trigger.
get_workflow_triggerGet workflow triggerGETGet one workflow trigger by id.
list_workflow_triggersList workflow triggersGETList workflow triggers.

Note, 3 operations

create_document_noteCreate document notePOSTAdd a note to a document.
delete_document_noteDelete document noteDELETEDelete one note from a document.
list_document_notesList document notesGETList the notes attached to a document.

Processed mail, 3 operations

bulk_delete_processed_mailBulk delete processed mailPOSTForget several processed-mail records at once.
get_processed_mailGet processed mailGETGet one processed-mail record by id.
list_processed_mailList processed mailGETList the mail messages already consumed by mail rules.

Log, 2 operations

get_log_fileGet log fileGETRead the contents of one server log file.
list_log_filesList log filesGETList the server log files that can be read.

Object, 1 operation

bulk_edit_objectsBulk edit objectsPOSTApply one bulk operation to a list of tags, correspondents, document types or storage paths.

Profile, 1 operation

get_own_profileGet own profileGETGet the profile of the authenticated user.

Search, 1 operation

autocomplete_search_termsAutocomplete search termsGETSuggest completions for a partially typed search term.

Statistic, 1 operation

get_statisticsGet statisticsGETGet instance-wide document counts and totals.

Status, 1 operation

get_system_statusGet system statusGETGet the health of the instance and its components.

Ui setting, 1 operation

get_ui_settingsGet ui settingsGETGet the interface settings and permissions of the authenticated user.

Version, 1 operation

get_latest_available_versionGet latest available versionGETCheck whether a newer Paperless-ngx release is available.

Showing the first 120 of 155 endpoints. The rest are in the product, searchable from the workflow builder and from chat.

Use Paperless-ngx from Claude Code, Cursor or Codex

Connect Paperless-ngx in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Paperless-ngx operations become tools the client can call, next to every other integration you connected.

Claude Code

claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"

Codex (~/.codex/config.toml)

[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"

Cursor, Claude Desktop and other JSON configs

{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect Paperless-ngx

Create your workspace
Sign up free. Nothing to install.
Connect Paperless-ngx once
Add your Paperless-ngx connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.