请求方式	POST
请求地址	`https://api.coze.cn/v1/databases/:database_id/records`
权限	`Database.createRecord` 确保调用该接口使用的访问令牌开通了`Database.createRecord`权限，详细信息参考鉴权方式。
接口说明	向数据库中插入一条或多条记录。

请求参数

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

Path

参数	类型	是否必选	示例	说明
database_id	String	必选	761070127115408****	待插入数据的数据库 ID。你可以在调用创建扣子数据库接口的返回结果中获取。

Body

参数	类型	是否必选	示例	说明
insert_rows	Array of JSON Map	必选	[{“user_id”: “alice”,“level”:“1”},{“user_id”: “molly”, “level”: “2”}]	需要插入的数据列表，每条记录为一个字段到值的映射。所有值均为字符串类型，系统会根据表结构自动转换。单次最大支持 `1000`条记录。
is_async	Boolean	可选	false	是否异步写入数据。 `true`：异步写入模式。数据写入请求将异步执行，适用于大批量数据写入场景。 `false`（默认值）：同步写入模式。数据写入请求将同步执行，适用于对数据实时性要求高的场景。
connector_id	String	可选	10000011	渠道 ID。扣子编程的渠道 ID 包括： 1024（默认值）：API 渠道。 999：Chat SDK。 10000122：扣子商店。 10000113：微信客服。 10000120：微信服务号。 10000121：微信订阅号。 10000126：抖音小程序。 10000127：微信小程序。 10000011：飞书。 998：WebSDK。自定义渠道 ID。自定义渠道 ID 的获取方式如下：在扣子编程左下角单击头像，在账号设置 > 发布渠道 > 企业自定义渠道管理页面查看渠道 ID。
connector_uid	String	可选	23903235371****	渠道 UID，用于标识用户在特定渠道内的唯一身份标识。扣子站内渠道（扣子编程调试台、商店和模板渠道），其渠道 UID 可通过以下路径获取：登录扣子编程。单击页面左下角的个人头像，进入个人主页页面。个人主页 URL 中的数字串即为渠道 UID，例如`https://code.coze.cn/u/23903235371**`中的 `23903235371**`。其他渠道：自定义设置渠道 UID。

返回参数

参数	类型	示例	说明
data	Object of InsertData	{“affected_rows”:3}	已插入的数据信息。
code	Long	0	调用状态码。 0 表示调用成功。其他值表示调用失败。你可以通过 msg 字段判断详细的错误原因。
msg	String	“”	状态信息。API 调用失败时可通过此字段查看详细错误信息。状态码为 0 时，msg 默认为空。
detail	Object of ResponseDetail	{“logid”:“20241210152726467C48D89D6DB2****”}	包含请求的详细信息的对象，主要用于记录请求的日志 ID 以便于排查问题。

InsertData

参数	类型	示例	说明
task_id	String	7525340985****	异步写入任务 ID，仅在异步写入（`is_async`=true）时返回。可通过查询异步执行结果接口，查询异步写入的执行结果。
affected_rows	Integer	3	同步写入数据的行数，仅在同步写入（`is_async`=false）时返回。

ResponseDetail

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

示例

请求示例

curl --location --request POST 'https://api.coze.cn/v1/databases/761284025805235****/records' \
--header 'Authorization: Bearer pat_O****' \
--header 'Content-Type: application/json' \
--data-raw '{
    "connector_id": "10000011",
    "connector_uid": "23903235371****",
    "insert_rows": [
        {
      "user_id": "alice",
      "level": "1"
    },
    {
      "user_id": "molly",
      "level": "2"
    }    
  ],
    "is_async": true
}'

返回示例

{
    "code": 0,
    "data": {
        "task_id": "7525340985****"
    },
    "msg": "",
    "detail": {
        "logid": "20241210152726467C48D89D6DB2****"
    }
}

错误码

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