MrDoc使用手册
🎊基本概念
📑文集功能
文档拖拽排序
设置文档水印
设置文集访问权限
生成文集PDF文件
文集协作/文集成员管理
文集基础信息配置和管理
导出文集
文档访问记录
文集置顶
文档禁止复制
转让文集
文集分享
开启文档评论
WebHook消息推送
首页隐藏文集
文集关联集
📄文档功能
下级文档控制
修改文档排序
设置文档上下级
文档分享
复制文档/移动文档
设置文档权限
文档历史版本
文档下载
导出Markdown文件
导出文档PDF
导出 Excel
文档附件
转让文档
文档目录显示
创建文档快捷方式
插入视频
文档标签
文档自动保存
🗄️素材功能
配置图片/附件上传限制大小
配置图片上传格式
配置附件上传格式/附件白名单
附件预览
转让附件/转让图片
清理图片
🎯导入与导出
导入文集(Markdown文件夹)
导入本地文本文件
导入本地 Word 文件
导入本地 Excel 表格文件
导入 Joplin 笔记本到 MrDoc
导入印象笔记到MrDoc
导入语雀知识库
🧑个人账号管理
设置默认编辑器
设置用户昵称
修改用户密码
绑定第三方账号
⚓站点配置和管理
站点信息配置
首页模板配置
用户与账户配置
统计代码配置
文档广告/信息块/自定义head配置
第三方登录配置
钉钉扫码登录和钉钉内免登配置
企业微信认证接入
LDAP 认证接入配置
OIDC 认证接入
第三方存储配置
minio 配置
七牛云OSS配置
阿里云OSS配置
AWS S3 配置
禁止更新检测
全站搜索模式
文档内图片缩略显示
站点反馈
接入 OnlyOffice
RSS订阅
站点单标签设置
AI 接入
基础配置
Dify 框架配置
发件邮件配置
🎈用户 Token API
获取用户 Token
获取文集列表
获取文集目录
获取文集文档列表
获取个人文档列表
获取指定文档内容
新建文集
新建文档
更新文档
上传图片
💻桌面客户端
📱手机客户端
🌐浏览器扩展
⌨️Obsidian 插件
常见使用问题索引
本文档使用「觅思文档专业版」发布
-
+
首页
获取文集文档列表
用于获取指定文集的文档列表 ## URL `/api/get_docs/?token={token}` ## 请求方法 `GET` #### 参数 | 参数名 | 类型 | 说明 | | --- | --- | --- | | `token` | string | 用户认证令牌,必填 | | `pid` | string | 文集ID,必填 | | `sort` | string | 排序方式,0为升序,1为降序,默认为0 | | `limit` | int | 每页显示的文档数量,默认为10 | | `page` | int | 当前页码,默认为1 | ## 响应结果 | 字段名 | 类型 | 说明 | | --- | --- | --- | | `status` | bool | 请求状态,`true`表示成功,`false`表示失败 | | `data` | list/dict | 响应数据,成功时为文档列表,失败时为错误信息 | | `cnt` | int | 总文档数量(仅在成功时返回) | ### 文档列表数据结构 | 字段名 | 类型 | 说明 | | --- | --- | --- | | `id` | int | 文档ID | | `name` | string | 文档名称 | | `parent_doc` | int | 上级文档ID | | `top_doc` | int | 所属文集ID | | `status` | int | 文档状态 | | `create_time` | datetime | 文档创建时间 | | `modify_time` | datetime | 文档修改时间 | | `create_user` | string | 文档创建者用户名 | | `editor_mode` | string | 文档类型 | ## 示例 ### Python 示例 ```python # coding:utf-8 import requests base_url = 'http://192.168.1.2' token = '56968edc671b65265d20ab12631c7d5737edd0dab373e4e8e54a28f9' url = base_url + '/api/get_docs/?token={}'.format(token) params = { 'pid': '58', 'sort': '0', 'limit': 10, 'page': 1 } resp = requests.get(url=url, params=params) print(resp.json()) ``` ### 响应示例 成功响应: ```json { "status": true, "data": [ { "id": 1, "name": "文档1", "parent_doc": 0, "top_doc": 58, "status": 1, "create_time": "2023-01-01T12:00:00Z", "modify_time": "2023-01-02T12:00:00Z", "create_user": "user1", "editor_mode": "markdown" }, ... ], "cnt": 20 } ``` 失败响应: ```json { "status": false, "data": "无文集权限" } ``` ### 错误码 | 错误信息 | 说明 | | --- | --- | | `无文集权限` | 用户没有该文集的浏览权限 | | `token无效` | 提供的token无效或已过期 | | `系统异常` | 系统内部错误 | ---
州的先生
2025年2月19日 15:13
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期