预览文件

以内联内容方式预览文件。

POST https://moi.matrixorigin.cn/newmoi/catalog/file/preview_stream

调用前准备

查询文件列表取得目标文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。 调用者需要根卷读取权限。

请求体

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/file/preview_stream" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "volume_id": "'"$VOLUME_ID"'",
    "file_id": "'"$FILE_ID"'"
  }'

字段

类型

必填

说明

file_id

string

文件 ID。

volume_id

string

文件所在的数据卷 ID。

成功响应

成功时返回 200,响应体为文件内容,并使用 Content-Disposition: inline。调用者需要根卷读取权限。

响应不是 JSON 包络。服务设置文件的内容类型;未提供时使用 application/octet-stream。如果文件名可用,响应头还会包含 Content-Disposition: inline

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: inline 或 attachment

[文件内容]

字段

类型

说明

HTTP 状态码

HTTP status

200

Content-Type

HTTP Header

文件 MIME 类型;未提供时为 application/octet-stream

Content-Disposition

HTTP Header

文件名可用时为内联展示。

响应体

binary

文件二进制内容。

错误响应

预览开始前失败时,响应使用 JSON 错误包络:

{
  "code": "ErrNotFound",
  "msg": "对象不存在",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中的附加数据;本示例为 null

后续操作

完成后查询 Catalog 详情确认结果。

最后更新于