套餐限制：扣子企业版（企业标准版、企业旗舰版）。
不支持渠道类型 OAuth 应用。使用 OAuth JWT 应用和服务访问令牌时，只需要有对应权限点即可。其余认证方式，只有智能体所有者能开启或关闭智能体的多人协作模式。
关闭智能体多人协作前，需要先调用删除智能体协作者 API 删除所有协作者。

基础信息

请求方式	POST
请求地址	`https://api.coze.cn/v1/bots/:bot_id/collaboration_mode`
权限	`Bot.switchDevelopMode` 确保调用该接口使用的访问令牌开通了 `Bot.switchDevelopMode` 权限，详细信息参考鉴权方式。
接口说明	开启或关闭智能体多人协作模式。

请求参数

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

Path

参数	类型	是否必选	示例	说明
bot_id	String	可选	73428668*****	需要设置协作模式的智能体 ID。进入智能体的开发页面，开发页面 URL 中 bot 参数后的数字就是智能体 ID。例如`https://www.coze.com/space/341**/bot/73428668*`，bot ID 为`73428668***`。

Body

参数	类型	是否必选	示例	说明
collaboration_mode	String	可选	collaboration	智能体的协作模式，枚举值： `single`：单用户模式。 `collaboration`：多人协作模式。说明如需将智能体多人协作模式变更为单用户模式，需要先调用删除智能体协作者 API 删除所有协作者。

参数

类型

是否必选

示例

说明

collaboration_mode

String

可选

collaboration

智能体的协作模式，枚举值：

single：单用户模式。
collaboration：多人协作模式。

说明

如需将智能体多人协作模式变更为单用户模式，需要先调用删除智能体协作者 API 删除所有协作者。

返回参数

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

ResponseDetail

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

示例

请求示例

curl --location --request POST 'https://api.coze.cn/v1/bots/73428668*****/collaboration_mode' \
--header 'Authorization : Bearer pat_Osa******' \
--header 'Content-Type : application/json' \
--data-raw '{
    "collaboration_mode": "collaboration"
}'

返回示例

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

错误码

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