# 创建文件夹

在卷或现有文件夹下创建文件夹。

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

## 调用前准备

先[查询数据库中的对象](list-database-objects.md)取得父卷或父文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和父卷或父文件夹 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$VOLUME_ID`：父卷或父文件夹 ID；服务将其解析到根卷。

调用者需要根卷的写入权限。

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `parent_volume_id` | integer | 是 | 父卷或父文件夹 ID；服务将其解析到根卷。 |
| `database_id` | integer | 否 | 所属数据库 ID。 |
| `name` | string | 是 | 文件夹名称，必须是有效标识符。 |
| `description` | string | 否 | 文件夹描述。 |

## 请求示例

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

## 成功响应

成功时返回 `200` 和新文件夹 ID。调用者需要根卷的写入权限。

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

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.id` | integer | 新建文件夹的 ID。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "name 无效",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - `parent_volume_id`、`name` 缺失，或名称无效。
  - 检查父对象 ID 和文件夹名称。
* - `403`
  - `ErrForbidden`
  - 当前身份没有根卷的写入权限。
  - 使用有写入权限的凭据，或联系管理员授权。
* - `409`
  - `ErrReadonly`
  - 目标卷所在数据库不可写。
  - 选择可写卷。
* - `500`
  - `ErrServer`
  - 服务无法创建文件夹。
  - 记录请求时间和错误信息后重试；持续失败时联系支持人员。
```

## 后续操作

记录 `data.id`。用该 ID [查询 Catalog 详情](get-catalog.md)确认保存结果。