# 下载文件

获取临时文件的下载地址。该接口只返回下载路径，不返回文件内容。

```text
POST https://moi.matrixorigin.cn/newmoi/connectors/file/download
```

## 调用前准备

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和临时文件 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：要下载文件的工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$CONN_FILE_ID`：上传或预览后取得的临时文件 ID，通过 `conn_file_id` 传递。
- `$DOWNLOAD_PATH`：本接口返回的相对下载路径，用于后续下载文件流。

## 请求体

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `conn_file_id` | string | 是 | 要下载的临时文件 ID。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/connectors/file/download" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"conn_file_id\": \"$CONN_FILE_ID\"
  }"
```

## 成功响应

成功时返回 `200` 和相对下载路径，不返回文件内容。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "url": "/newmoi/connectors/file/stream?conn_file_id=conn_file_01"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.url` | string | 相对下载路径，不是文件内容。使用 `https://moi.matrixorigin.cn` 与该路径组成文件流请求地址。 |

使用返回的路径下载文件流，并携带与本接口相同的认证请求头：

```bash
curl -L "https://moi.matrixorigin.cn$DOWNLOAD_PATH" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -o ./downloaded-file
```

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "invalid file identifier",
  "data": null
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `200`
  - `ErrParamInvalid`
  - JSON 请求体无效；该接口以此状态返回该类错误。
  - 同时检查 HTTP 状态和 `code`，再修正请求体。
* - `404`
  - `ErrNotFound`
  - `conn_file_id` 为空或临时文件不存在。
  - 重新上传文件，或确认临时文件 ID。
* - `401`
  - `ErrUnauthorized`
  - 访问令牌无效或已失效。
  - 更新访问令牌后重试。
* - `403`
  - `ErrForbidden`
  - 调用者无权访问临时文件。
  - 检查工作区 ID 和访问权限。
* - `503`
  - `ErrServiceUnavailable`
  - 服务暂时无法生成下载路径。
  - 保留脱敏错误信息后重试。
```

## 后续操作

记录 `data.url` 作为 `$DOWNLOAD_PATH`，按上方文件流请求下载文件。不再需要临时文件时，使用 `conn_file_id` [删除文件](delete-file.md)。