MrDoc使用说明手册
🎊 基本概念
🚀 快速开始
创建文集
创建文档
添加成员协作
📑 文档与知识库基础
文集基础配置
文集置顶
WebHook消息推送
首页隐藏文集
文集关联集
文集选项卡配置
📄 文档编辑与内容创作
添加文档附件
显示文档目录
创建文档快捷方式
设置文档标签
设置文档别名
插入视频
文档自动保存
📦 文档管理与组织
文集目录排序
修改文档排序
下级文档控制
设置文档上下级
文档历史版本
转让文集
转让文档
复制文档/移动文档
文档访问记录
文集导出与下载
文档下载与导出
导出文档PDF
文档拖拽排序
🔐 协作与权限管理
设置文档权限
设置文集访问权限
文档禁止复制
设置文档水印
文集协作/文集成员管理
文档分享
文集分享
开启文档评论
🗄️ 图片与附件管理
配置图片/附件上传限制大小
配置图片上传格式
配置附件上传格式/附件白名单
附件预览
转让附件/转让图片
清理图片
🎯 数据导入与迁移
桌面客户端导入
导入 Joplin 笔记本
导入印象笔记
Web 端导入
命令行导入
Web端导出
🔑 第三方登录配置
钉钉扫码登录和钉钉内免登配置
企业微信认证接入
LDAP 认证接入配置
OIDC 认证接入
微信公众号网页授权
📦 第三方存储配置
minio 配置
七牛云OSS配置
阿里云OSS配置
AWS S3 配置
🤖 AI知识库与智能问答
基础配置
AI模型配置
Qdrant部署
Dify 框架配置
重建文档AI索引
AI功能
AI 文档创作
AI知识库问答
AI 问答机器人
企业微信智能机器人
📝 OnlyOffice 接入
📊 Drawio 接入
⚓ 系统设置和管理
站点信息配置
首页模板配置
官网主题首页配置说明
用户与账户配置
统计代码配置
文档广告/信息块/自定义head配置
禁止更新检测
全站搜索模式
文档内图片缩略显示
站点反馈
RSS订阅
站点单标签设置
发件邮件配置
站点数据导出
编辑器配置
文集文档页面显示站点顶部导航栏
🧑 个人账号管理
设置默认编辑器
设置用户昵称
修改用户密码
绑定第三方账号
🎈 API 与开发者接口
获取用户 Token
获取文集列表
获取文集目录
获取文集文档列表
获取个人文档列表
获取指定文档内容
新建文集
新建文档
更新文档
上传图片
上传附件
验证用户Token
上传本地Office/PDF文件为文档
🖥️ 客户端与生态集成
💻桌面客户端
📱手机客户端
🌐浏览器扩展
⌨️Obsidian 插件
常见使用问题索引
Powered by MrDoc Pro
-
+
home
🎈 API 与开发者接口
上传本地Office/PDF文件为文档
上传本地Office/PDF文件为文档
## URL `/api/upload_office_doc/?token={token}` ## 请求方法 `POST` ## 参数 ### Query 参数 | 参数名 | 数据类型 | 是否必填 | 含义 | | ----- | ------ | ---- | -------------------- | | token | string | 是 | 用户 Token,用于身份验证和权限校验 | ### Body 参数(form-data) | 参数名 | 数据类型 | 是否必填 | 含义 | | ---------- | ------- | ---- | ------------------------------------------------------------ | | pid | integer | 是 | 文集 ID,Office 文档将创建到指定文集中 | | parent_doc | integer | 否 | 父级文档 ID,默认为 `0`,表示创建为一级文档 | | file | file | 是 | 上传的 Office 文件,支持 Word、Excel、PowerPoint 等 MrDoc 支持的 Office 格式 | ## 响应结果 | 字段名 | 数据类型 | 含义 | | ------ | --------------- | ------------------------------- | | status | boolean | 请求是否成功,`true` 表示成功,`false` 表示失败 | | data | object / string | 成功时返回文档信息,失败时返回错误消息 | ### 响应示例 **成功响应:** ```json { "status": true, "data": { "doc_id": 123, "filename": "2026/07/项目需求文档.docx" } } ``` 返回字段说明: | 字段名 | 数据类型 | 含义 | | -------- | ------- | --------------------------- | | doc_id | integer | 创建成功后的文档 ID | | filename | string | Office 文件在 MrDoc 存储目录中的相对路径 | **失败响应:** Token 无效: ```json { "status": false, "data": "token无效" } ``` 用户无权限: ```json { "status": false, "data": "用户无权限操作" } ``` 参数错误: ```json { "status": false, "data": "参数错误" } ``` 无文集权限: ```json { "status": false, "data": "无文集权限" } ``` 未选择文件: ```json { "status": false, "data": "未选择文件" } ``` 文件大小超出限制: ```json { "status": false, "data": "文件大小超出限制" } ``` 文件格式不支持: ```json { "status": false, "data": "文件格式不支持" } ``` 系统异常: ```json { "status": false, "data": "系统异常" } ``` --- ## 权限说明 * 用户必须具有作者(Writer)权限。 * 用户必须具有新增文档权限(`writer_value[1] == '1'`)。 * 用户必须拥有目标文集的新增权限,否则接口将返回 **"无文集权限"**。 --- ## Python 示例 ```python # coding: utf-8 import requests # MrDoc 地址 base_url = 'http://192.168.1.2' # 用户 Token token = '56968edc671b65265d20ab12631c7d5737edd0dab373e4e8e54a28f9' url = f'{base_url}/api/upload_office_doc/?token={token}' # 上传到的文集ID pid = 1 # 父级文档ID(0表示一级文档) parent_doc = 0 # 本地 Office 文件 office_file = '/path/to/项目需求文档.docx' with open(office_file, 'rb') as f: files = { 'file': f } data = { 'pid': pid, 'parent_doc': parent_doc } resp = requests.post(url, data=data, files=files) print(resp.json()) ``` --- ## 错误码说明 | 错误消息 | 说明 | | -------- | ----------------------------- | | token无效 | 提供的 Token 不存在或已失效 | | 用户无权限操作 | 当前用户没有创建文档权限 | | 参数错误 | 请求缺少必要参数(如 `pid`) | | 无文集权限 | 当前用户没有目标文集的新增权限 | | 未选择文件 | 请求中未上传 Office 文件 | | 文件大小超出限制 | 上传文件超过系统允许的最大大小或文件为空 | | 文件格式不支持 | 上传的文件不是 MrDoc 支持的 Office 文档格式 | | 系统异常 | 服务器处理请求时发生异常 |
州的先生
July 8, 2026, 10:42 p.m.
Forward
Favorites
Last
Next
Scan the QR Code
Copy link
Scan the QR code to share.
Copy link
share
link
type
password
Update password
Validity period
Markdown file
Word document
PDF document (print)