# 创建知识库

创建空知识库。创建后可单独添加数据源和语义条目。

```text
POST https://moi.matrixorigin.cn/newmoi/semantic-models
```

## 调用前准备

准备有目标工作区访问权限且具有创建知识库权限的个人访问令牌和目标工作区 ID。

下方示例使用：

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

## 请求体

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `name` | string | 是 | 知识库名称。 |
| `description` | string | 否 | 覆盖范围和使用说明。 |
| `tables` | JSON | 否 | 兼容的旧式表来源定义。新接入来源请使用添加数据源接口。 |
| `files` | JSON | 否 | 兼容的旧式文件来源定义。新接入来源请使用添加数据源接口。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/semantic-models" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<KNOWLEDGE_BASE_NAME>",
    "description": "<DESCRIPTION>",
    "tables": []
  }'
```

## 成功响应

成功时返回 `201`。保存 `data.id`，后续接口将它作为 `model_id` 使用。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 401,
    "name": "product_docs",
    "description": "产品文档",
    "tables": [],
    "source_counts": {
      "files": 0,
      "tables": 0,
      "total": 0
    },
    "created_at": 1735632000,
    "updated_at": 1735632000
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.id` | integer | 新知识库 ID。 |
| `data.name` | string | 已创建的知识库名称。 |
| `data.description` | string | 已保存的说明；未设置时可能省略。 |
| `data.tables` | JSON | 兼容的旧式表来源定义。 |
| `data.files` | JSON | 兼容的旧式文件来源定义。 |
| `data.source_counts` | object | 创建快照中的来源计数；空知识库各项为 `0`。 |
| `data.created_at` | integer | Unix 时间戳。 |
| `data.updated_at` | integer | Unix 时间戳。 |

## 错误响应

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

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 请求体不是有效 JSON，或缺少 `name`。
  - 提供非空名称并检查 JSON。
* - `401`
  - `ErrUnauthorized`
  - API Key 无效或已失效。
  - 检查 API Key。
* - `403`
  - `ErrForbidden`
  - 调用者没有创建知识库的权限。
  - 检查工作区授权。
* - `409`
  - `ErrConflict`
  - 服务拒绝重复或冲突的知识库定义。
  - 修改冲突对象或使用已有知识库。
* - `500`
  - `ErrServer`
  - 服务未能创建知识库。
  - 保留脱敏后的响应信息后重试。
```

## 后续操作

使用 `data.id` [添加数据源](add-data-sources.md)或[上传本地文件](upload-local-file.md)。