预览工作区文件内容

读取浏览器预览内容,必要时将Office文档转换为PDF。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{id}/files/{file_id}/preview

调用前准备

BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

准备目标工作区个人访问令牌;WORKSPACE_ID须与路径工作区一致,FILE_ID来自实际文件结果。BASE_URL包含同环境产品前缀,示例文件/ID仅为占位值。

请求参数

curl --fail-with-body -sS -X GET "$BASE_URL/workspaces/$WORKSPACE_ID/files/$FILE_ID/preview" \
  -H "X-API-Key: $MOI_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -o "$OUTPUT_FILE"

没有业务请求体。路径中的工作区和文件ID按实际目标填写。

原文件及转换后内容均受100MiB预览上限约束。Office预览依赖已配置转换器。HTML/HTM/SVG按附件返回,其他适用格式可内联;预览可能不同于原始下载字节。

成功响应

sample

响应为字节流;消费并关闭流,检查读取/退出状态后使用文件。响应开始后失败可中断连接。

错误响应

{
  "code": 2,
  "message": "示例错误信息"
}

格式不支持为400/2,超过预览大小限制为413/14,不存在404/3,权限拒绝403/5,授权不可用503/15,转换失败可500/1。

最后更新于