本文档由
石墨办公
提供。
石墨文档中台-开发文档
co1.8.20260830
co1.8.20260830
co1.8.20260630
全部文档
前端接口
后端接口
回调接口
全部文档
前端接口
后端接口
回调接口
co1.8.20260830
co1.8.20260830
co1.8.20260630
石墨官网
预约演示
co1.8.20260830
co1.8.20260830
co1.8.20260630
文件-预览 API
复制页面
整体概述
错误码说明
文件-预览 API
访问预览文件
GET
创建文件预览缓存
POST
文件-协同编辑文件管理 API
访问协同编辑文件
创建协同文件(新版带额外参数)
POST
创建协同文件副本
POST
删除协同文件
DELETE
文件-导入导出 API
文件导入
文件导入说明
创建导入任务
获取导入进度
创建导入任务(旧版)
获取导入进度(旧版)
文件导出
文件导出流程
导出文件
获取导出进度
文件-文档文件(类 Markdown) API
获取文档中的评论列表
GET
文件-文稿文件(Word) API
文稿书签说明
读取文稿书签内容
GET
替换文稿书签内容
PUT
文件-表格文件(Excel) API
表格接口参数说明
获取表格内容
GET
获取表格中的评论数
GET
更新表格内容
POST
追加表格内容
PUT
删除表格行
DELETE
新增表格工作表
POST
文件-获取额外信息 API
获取文件的纯文本内容
GET
文件纯文本字数统计
POST
获取文件的历史列表
GET
获取文件的版本列表
GET
获取文件内容中所有的 @ 人信息列表
GET
还原文件历史版本
POST
系统管理 API
用户席位管理
用户席位状态说明
获取用户列表和席位状态
激活用户席位
取消用户席位
批量设置用户席位
其他 API
上报事件
创建行为历史
推送文件内全部的用户
推送用户全部的 websocket 连接
文件-预览 API
复制页面
访问预览文件
GET
/sdk/v2/api/cloud-files/{fileID}/page
Run in Apifox
Run in Apifox
用于在浏览器上渲染出预览的页面, 需要嵌入Iframe使用。
只读模式访问协同文档
参考
预览协同文档
流程,后续说明仅针对 预览文档
此接口依赖的回调接口
获取文件元信息-预览文档
获取当前用户信息
对于同一个文件, 第一次调用该接口时, 后台会异步调用
创建文件预览缓存
接口创建任务,创建成功后才会渲染出预览页面。
预览加速
如果需要加快第一次打开文件的速度, 可在服务端提前调用
创建文件预览缓存
接口创建预览缓存,这样可以使用户打开预览时无需等待。
预览缓存
由于预览缓存机制,同一fileId经过第一次预览产生预览缓存后,再自定义更新回调中downloadUrl内容是无法修改预览结果的。
不支持预览0kb大小的文件
方案一:用户直接访问(首次访问较慢)
#
方案二:服务端预热缓存(推荐方案)
#