# 创建 Catalog

在当前工作区创建 Catalog。

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

## 调用前准备

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

下方示例使用：

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

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `name` | string | 是 | Catalog 名称，必须是有效标识符。 |
| `description` | string | 否 | Catalog 说明。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/create" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<CATALOG_NAME>",
    "description": "<CATALOG_DESCRIPTION>"
  }'
```

## 成功响应

成功时返回 `200`。保存 `data.id` 用于后续操作。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 1
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.id` | integer 或 null | 新建 Catalog 的 ID；服务端未提供时为 `null`。 |

## 错误响应

```json
{
  "code": "ErrAlreadyExists",
  "msg": "Catalog 名称已存在",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 请求体无效、名称为空或不是有效标识符。
  - 使用有效且非空的 `name`。
* - `403`
  - `ErrForbidden`
  - 当前身份没有创建 Catalog 的权限。
  - 请求授予 `catalog.create` 权限。
* - `409`
  - `ErrAlreadyExists`
  - 当前工作区已有同名 Catalog。
  - 更换名称或查询已有 Catalog。
* - `500`
  - `ErrServer`
  - 服务端未能创建 Catalog。
  - 稍后重试。
```

## 后续操作

使用 `data.id` [查询 Catalog 详情](get-catalog.md)。