请求方式	POST
请求地址	`https://api.coze.cn/v1/datasets`
权限	`createKnowledge` 确保调用该接口使用的访问令牌开通了 `createKnowledge` 权限，详细信息参考鉴权方式。
接口说明	调用此接口创建知识库。

请求参数

参数	取值	说明
Authorization	Bearer $Access_Token	用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。
Content-Type	application/json	请求正文的方式。

Body

参数	类型	是否必选	示例	说明
name	String	必选	产品文档	知识库名称，长度不超过 100 个字符。
space_id	String	必选	744632974166804****	知识库所在的空间的工作空间 ID。Space ID 是空间的唯一标识。进入指定空间，空间页面 URL 中 `w` 参数后的数字就是工作空间 ID。例如`https://code.coze.cn/w/75814654762959*/projects`，Space ID 为 `75814654762959*`。
format_type	Integer	必选	2	知识库类型。取值包括： 0：文本类型 2：图片类型
description	String	可选	A 的产品文档	知识库描述信息。
file_id	String	可选	744667846938145****	知识库图标，应传入上传文件接口中获取的 file_id。

返回参数

参数	类型	示例	说明
data	Object of CreateDatasetOpenApiData	{ “dataset_id”: “744668935865830****” }	返回内容
code	Long	0	状态码。 0 代表调用成功。
msg	String	“”	状态信息。API 调用失败时可通过此字段查看详细错误信息。状态码为 0 时，msg 默认为空。
detail	Object of ResponseDetail	20241210160547B25AEC1917B03A2F1F07	本次请求的日志 ID。

CreateDatasetOpenApiData

参数	类型	示例	说明
dataset_id	String	744668935865830****	新知识库的 ID。

ResponseDetail

参数	类型	示例	说明
logid	String	20241210152726467C48D89D6DB2****	本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。

示例

请求示例

curl --location --request POST 'https://api.coze.cn/v1/datasets' \
--header 'Authorization: Bearer pat_xitq9LWlowpX3qGCih1lwpAdzvXN****' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "产品文档",
    "description": "产品文档",
    "space_id": "731121948439879****",
    "format_type": 2,
    "file_id": "744667846938145****"
}'

返回示例

{
  "code": 0,
  "data": {
    "dataset_id": "744668935865830****"
  },
  "msg": "",
  "detail": {
    "logid": "20241210160547B25AEC1917B0***"
  }
}

错误码

如果成功调用扣子编程的 API，返回信息中 code 字段为 0。如果状态码为其他值，则表示接口调用失败。此时 msg 字段中包含详细错误信息，你可以参考错误码文档查看对应的解决方法。

CreateDatasetOpenApiData