> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coze.cn/llms.txt
> Use this file to discover all available pages before exploring further.

创建工作空间。
## 基础信息 {#基础信息}
<!-- @cols-width: 180,680 -->
| | | \
|**请求方式** |POST |
|---|---|
| | | \
|**请求地址** |```Plain Text |\
| |https://api.coze.cn/v1/workspaces |\
| |``` |\
| | |
| | | \
|**权限** |`createWorkspace` |\
| |确保调用该接口使用的访问令牌开通了 `createWorkspace` 权限，详细信息参考[鉴权方式](https://docs.coze.cn/developer_guides/authentication)。 |
| | | \
|**接口说明** |创建工作空间。 |

## 请求参数 {#请求参数}
### Header {#Header}
<!-- @cols-width: 144,165,551 -->
| | | | \
|**参数** |**取值** |**说明** |
|---|---|---|
| | | | \
|Content-Type |application/json |解释请求正文的方式。  |
| | | | \
|Authorization |Bearer *$Access_Token* |用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考[准备工作](https://docs.coze.cn/developer_guides/preparation)。 |

### Body {#Body}
<!-- @cols-width: 163,121,86,164,312 -->
| | | | | | \
|**参数** |**类型** |**是否必选** |**示例** |**说明** |
|---|---|---|---|---|
| | | | | | \
|name |String |必选 |文档组的工作空间 |自定义的空间名称，最大长度为 50 个字符。 |
| | | | | | \
|description |String |必选 |文档组内部使用的工作空间。 |空间的描述信息，用于详细说明空间的用途或特点，最大长度为 2000 个字符。 |
| | | | | | \
|icon_file_id |String |可选 |73694959811**** |作为空间图标的文件 ID。 |\
| | | | | |\
| | | | |* 未指定文件 ID 时，使用扣子编程默认的工作空间图标。 |\
| | | | |* 如需使用自定义图标，应先通过[上传文件](https://docs.coze.cn/developer_guides/upload_files) API 上传本地文件，从接口响应中获取文件 ID。文件 ID 作为空间图标时，有效期为永久有效。 |
| | | | | | \
|coze_account_id |String |可选 |749088814445*** |组织 ID，用于标识工作空间所属的组织。 |\
| | | | |扣子个人版中，无需设置此参数。 |\
| | | | |:::tip 说明 |\
| | | | |默认在个人账号下创建工作空间，如果需要在企业的组织下创建工作空间，你需要传入组织 ID。 |\
| | | | |你可以在**组织设置**页面查看对应的组织 ID。 |\
| | | | |::: |
| | | | | | \
|owner_uid |String |可选 |user_1234567890 |指定空间所有者的扣子用户的 UID。 |\
| | | | |:::tip 说明 |\
| | | | |* 扣子个人版中，无需设置此参数，默认当前用户为空间所有者。 |\
| | | | |* 扣子企业版（企业标准版、企业旗舰版）中，可以指定 `coze_account_id` 对应组织中的员工为空间所有者，未指定时默认 Token 的创建者为空间所有者。 |\
| | | | |::: |\
| | | | |你可以单击扣子编程左下角的头像，选择**账号设置**，在页面底部查看扣子用户的 UID。 |\
| | | | |![Image=350x341](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/c77171908fad4b69a328dfd3210b3576~tplv-goo7wpa0wc-image.image) |

## 返回参数 {#返回参数}
<!-- @cols-width: 100,149,166,445 -->
| | | | | \
|**参数** |**类型** |**示例** |**说明** |
|---|---|---|---|
| | | | | \
|data |Object of [OpenCreateSpaceRet](#opencreatespaceret) |{"id":"753232939603****"} |工作空间的相关信息。 |
| | | | | \
|code |Long |0 |调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。 |
| | | | | \
|msg |String |"" |状态信息。API 调用失败时可通过此字段查看详细错误信息。 |\
| | | |状态码为 0 时，msg 默认为空。 |
| | | | | \
|detail |Object of [ResponseDetail](#responsedetail) |{"logid":"20241210152726467C48D89D6DB2****"} |包含请求的详细信息的对象，主要用于记录请求的日志 ID 以便于排查问题。 |

### OpenCreateSpaceRet {#opencreatespaceret}
<!-- @cols-width: 100,149,166,445 -->
| | | | | \
|**参数** |**类型** |**示例** |**说明** |
|---|---|---|---|
| | | | | \
|id |String |753232939603**** |创建的工作空间的 ID。 |

### ResponseDetail {#responsedetail}
<!-- @cols-width: 100,149,166,445 -->
| | | | | \
|**参数** |**类型** |**示例** |**说明** |
|---|---|---|---|
| | | | | \
|logid |String |20241210152726467C48D89D6DB2**** |本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考[获取帮助和技术支持](https://docs.coze.cn/guides/help_and_support)。 |

## 示例 {#示例}
### 请求示例 {#请求示例}
```JSON
curl --location --request POST 'https://api.coze.cn/v1/workspaces' \
--header 'Authorization : Bearer pat_O******' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "文档组的工作空间",
    "description": "文档组内部使用的工作空间。",
    "icon_file_id": "73694959811****",
    "coze_account_id": "749088814445***",
}'
```

### 返回示例 {#返回示例}
```JSON
{
  "data": {
    "id": "753232939603****"
  },
  "code": 0,
  "msg": "",
  "detail": {
    "logid": "20241210152726467C48D89D6DB2****"
  }
}
```

## 错误码 {#错误码}
如果成功调用扣子编程的 API，返回信息中 code 字段为 0。如果状态码为其他值，则表示接口调用失败。此时 msg 字段中包含详细错误信息，你可以参考[错误码](https://docs.coze.cn/developer_guides/coze_error_codes)文档查看对应的解决方法。