# 上传文件

上传一个未关联到卷的文件。上传后可通过[创建文件](create-file.md)将其关联到卷。

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

## 调用前准备

使用 `multipart/form-data` 请求。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

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

## 表单字段

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `file` | file | 是 | 要上传的本地文件。 |

## 请求示例

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

## 成功响应

成功时返回 `200` 和 `file_id`。该请求只上传文件，并不将它关联到某个卷。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file-123"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.file_id` | string | 上传后生成的文件 ID；可用于[创建文件](create-file.md)请求。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "缺少 file 字段",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - multipart 请求中缺少 `file` 字段。
  - 使用 `-F "file=@<本地文件>"` 重新提交。
* - `403`
  - `ErrForbidden`
  - 当前身份没有上传权限。
  - 使用有上传权限的凭据，或联系管理员授权。
* - `500`
  - `ErrServer`
  - 服务无法保存上传内容。
  - 保留脱敏后的响应信息后重试；持续失败时联系支持人员。
```

## 后续操作

使用 `data.file_id` [创建文件](create-file.md)将文件关联到卷。