获取 HTML 格式文档预览

最近更新时间:2025-10-24 15:25:21

我的收藏

功能描述

用于获取 HTML 格式文档预览。
说明:
返回 HTML 或 JPG 格式的文档用于预览。
如果文件不属于可预览的文档类型,则会跳转至文件的下载链接。

请求

请求示例

GET /api/v1/file/{LibraryId}/{SpaceId}/{FilePath}?preview&history_id={HistoryId}&purpose={Purpose}&access_token={AccessToken}&user_id={UserId}

请求参数

请求参数
描述
类型
是否必选
LibraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
SpaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
FilePath
完整文件路径,例如 foo/bar/file.docx,获取请参见 查看文件详情
String
HistoryId
历史版本 ID,用于获取不同版本的文件内容,不传默认为最新版,获取请参见 查询历史版本列表
String
Type
文档预览方式,如果设置为"pic"则以jpg格式预览文档首页,否则以html格式预览文档
String
AccessToken
访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数获取请参见 生成访问令牌
String
UserId
用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参见 生成访问令牌接口
String

请求体

该请求无请求体。

响应

响应码

获取成功,返回 HTTP 200 OK。
重定向,返回 HTTP 302 Found,响应头 Location 包含可直接用于展示或下载的文件 URL。

响应体

响应体为预览文件内容。