下载文件

下载文件内容。

POST https://api.moi.matrixorigin.cn/v5/catalog/file/download

调用前准备

先查询文件列表取得目标文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/file/download" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_id": "'"$FILE_ID"'"
  }' \
  -o ./downloaded-file

字段

类型

必填

说明

file_id

string

是

文件 ID，不能为空。

volume_id

string

否

卷 ID。

as_zip

boolean

否

是否以 ZIP 形式下载。

成功响应

成功时返回 200 和文件内容。响应体不是 JSON 格式。

文件名可用时，响应头 Content-Disposition 指定附件下载并提供文件名。未提供内容类型时，Content-Type 为 application/octet-stream。

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": "ErrParamInvalid",
  "msg": "file_id 不能为空",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

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

后续操作

下载完成后如需继续管理，返回查询 Catalog 详情。

最后更新于