Paperless文档管理

技能简介

本技能通过REST API与Paperless-ngx开源文档管理系统交互，支持文档的上传、搜索、下载、元数据管理及标签/对应方/文档类型等组织维度的维护。

能做什么

• 按关键词、日期、标签、对应方等多条件检索文档
• 上传PDF等文件并自动触发OCR处理
• 下载原始文件或已归档的OCR版本
• 批量修改文档标签、对应方、文档类型
• 管理标签、对应方、文档类型的增删改查
• 查询异步任务（如OCR）的处理状态

使用说明

1. 环境配置

需设置以下环境变量：

PAPERLESS_URL=https://paperless.example.com
PAPERLESS_TOKEN=your_api_token_here

Token从Paperless-ngx后台「设置 → API令牌」获取。

2. 安装依赖

本技能基于HTTP调用，无需额外安装包，确保运行环境支持curl或等效HTTP客户端即可。

3. 典型调用示例

搜索发票文档：

curl -s "$PAPERLESS_URL/api/documents/?query=invoice" \
  -H "Authorization: Token $PAPERLESS_TOKEN"

上传新文档：

curl -s "$PAPERLESS_URL/api/documents/post_document/" \
  -H "Authorization: Token $PAPERLESS_TOKEN" \
  -F "document=@contract.pdf" \
  -F "title=采购合同2024" \
  -F "tags=5" \
  -F "tags=8"

批量添加标签：

curl -s -X POST "$PAPERLESS_URL/api/documents/bulk_edit/" \
  -H "Authorization: Token $PAPERLESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documents":[10,11,12],"method":"add_tag","parameters":{"tag":7}}'

输入与输出

见下方输入与输出表格。

风险提示

• API令牌具备完整读写权限，泄露可导致文档数据被窃取或篡改
• 删除操作不可逆，批量删除前建议先验证筛选条件
• OCR处理为异步任务，上传后需轮询任务状态确认完成
• 大文件上传可能超时，建议分批次处理或调整服务器限制

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/oskarstark/paperless-ngx/SKILL.md
来源类型：GitHub仓库