# 上传文件

上传本地文件，取得可预览、下载或用于后续导入的临时文件 ID。上传只保存临时文件，不会开始导入任务。

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

## 调用前准备

使用 `multipart/form-data` 请求。当前公开契约未定义单次上传的文件大小上限。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：要上传文件的工作区 ID，通过 `X-Workspace-ID` Header 传递。

## 表单字段

本文中，类型后的 `[]` 表示数组，例如 `file[]` 表示文件数组。

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `files` | file[] | 否 | 要上传的一个或多个文件。推荐使用 `files`；服务会读取 multipart 表单中的全部文件字段。要取得可用的临时文件 ID，至少传入一个文件。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/connectors/file/upload" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -F 'files=@./data.csv'
```

## 成功响应

成功时返回 `200`。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "conn_file_ids": ["conn_file_01"],
    "file_ids": ["file_01"]
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.conn_file_ids` | string[] 或 null | 临时连接器文件 ID，按上传文件顺序返回。未传入文件时为 `null`。 |
| `data.file_ids` | string（字符串数组） | 存储文件 ID，与 `data.conn_file_ids` 按相同顺序对应。未传入文件时可能省略。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "invalid multipart form",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - multipart 请求无效。
  - 检查表单格式和文件内容后重试。
* - `401`
  - `ErrUnauthorized`
  - 访问令牌无效或已失效。
  - 更新访问令牌后重试。
* - `403`
  - `ErrForbidden`
  - 调用者无权在该工作区上传文件。
  - 检查工作区 ID 和访问权限。
* - `503`
  - `ErrServiceUnavailable`
  - 服务暂时无法存储临时文件。
  - 保留脱敏错误信息后重试。
```

## 后续操作

保存返回的 `data.conn_file_ids`。需要查看内容时[预览文件](preview-file.md)；需要取出文件时[下载文件](download-file.md)。确认无用后[删除文件](delete-file.md)。