预览文件¶
以内联内容方式预览文件。
POST https://moi.matrixorigin.cn/newmoi/catalog/file/preview_stream
调用前准备¶
先查询文件列表取得目标文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$FILE_ID:要预览的文件 ID。$VOLUME_ID:目标文件所在的数据卷 ID。
调用者需要根卷读取权限。
请求体¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
文件 ID。 |
|
string |
是 |
文件所在的数据卷 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"'"
}'
成功响应¶
成功时返回 200,响应体为文件内容,并使用 Content-Disposition: inline。调用者需要根卷读取权限。
响应不是 JSON 包络。服务设置文件的内容类型;未提供时使用 application/octet-stream。如果文件名可用,响应头还会包含 Content-Disposition: inline。
响应项 |
说明 |
|---|---|
HTTP 状态码 |
|
|
文件 MIME 类型;未提供时为 |
|
文件名可用时为内联展示。 |
响应体 |
文件二进制内容。 |
错误响应¶
预览开始前失败时,响应使用 JSON 错误包络:
{
"code": "ErrNotFound",
"msg": "对象不存在",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
|
传入有效的文件 ID。 |
|
|
当前身份没有所属根卷读取权限。 |
使用有读取权限的凭据,或联系管理员授权。 |
|
|
文件不存在。 |
检查文件 ID。 |
|
|
服务无法打开文件预览流。 |
记录请求时间和错误信息后重试;持续失败时联系支持人员。 |
后续操作¶
完成后查询 Catalog 详情确认结果。