# 上传本地文件

上传本地文件，供创建或追加知识库来源使用。上传成功只表示文件已保存，不表示内容已可检索。

```text
POST https://moi.matrixorigin.cn/newmoi/semantic-models/{model_id}/local-files/upload
```

## 调用前准备

先[查询知识库列表](list-knowledge-bases.md)取得目标知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

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

该接口的请求类型为 `multipart/form-data`；示例使用 `curl -F` 提交文件，不要添加 `Content-Type: application/json`。

## 路径参数

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `model_id` | integer | 目标知识库 ID。 |

## 表单字段

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

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID/local-files/upload" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -F "file=@./product-guide.pdf"
```

## 成功响应

成功时返回 `200`。保存 `data.file_id`，将该值构造成 `local_file` 来源，再调用添加数据源接口。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file_01"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.file_id` | string | 已上传文件的 ID；添加本地文件来源时使用该值。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "file is required",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 缺少名为 `file` 的 multipart 文件，或 `model_id` 无效。
  - 使用 `multipart/form-data` 重新提交文件，并检查路径 ID。
* - `401`
  - `ErrUnauthorized`
  - API Key 无效或已失效。
  - 检查 API Key。
* - `403`
  - `ErrForbidden`
  - 调用者没有向该知识库上传文件的权限。
  - 检查工作区和对象授权。
* - `404`
  - `ErrNotFound`
  - 知识库不存在或当前调用者不可见。
  - 重新列出知识库并确认 ID。
* - `500`
  - `ErrServer`
  - 服务未能存储文件。
  - 保留脱敏后的响应信息后重试。
```

## 后续操作

使用 `data.file_id` [添加数据源](add-data-sources.md)。