开发工具/API 参考/智能体和应用/更新智能体
更新智能体
更新于: 2026-06-25 19:29:14
更新智能体的配置。
通过此 API 可更新通过扣子编程或 API 方式创建的所有智能体。通过 API 方式修改智能体除了智能体名称和描述、头像、人设与回复逻辑及开场白之外,还支持为智能体绑定知识库和插件。
不支持通过 API 绑定火山知识库,只能绑定扣子知识库。
| 请求方式 | POST |
|---|---|
|
请求地址 |
|
|
权限 |
确保调用该接口使用的访问令牌开通了 |
| 接口说明 | 调用接口修改智能体的配置。 |
| 参数 | 取值 | 说明 |
|---|---|---|
| Authorization | Bearer $AccessToken | 用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作。 |
| Content-Type | application/json | 解释请求正文的方式。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
bot_id |
String |
必选 |
73428668***** |
待修改配置的智能体 ID。 进入智能体的 开发页面,开发页面 URL 中 |
| name | String | 可选 | 每日学一菜 | 智能体的名称。长度为 1~ 20 个字符。 |
| description | String | 可选 | 每天教你一道菜的做法,暑假之后你将成为中餐大厨~ | 智能体的描述信息。长度为 0~ 500 个字符。默认为空。 |
|
icon_file_id |
String |
可选 |
73694959811**** |
作为智能体头像的文件 ID。
|
| prompt_info | Object of PromptInfo | 可选 | { “prompt”: “你是一位经验丰富的中餐大厨,能够熟练传授各类中餐的烹饪技巧,每日为大学生厨师小白教学一道经典中餐的制作方法。” } | 智能体的人设与回复逻辑。 |
| onboarding_info | Object of OnboardingInfo | 可选 | { “prologue”: “欢迎你,学徒,今天想学一道什么样的菜?”, “suggested_questions”: [ “川菜,我想吃辣的”, “广东菜,来点鲜的”, “随机教我一道菜” ] } | 智能体的开场白相关设置。 |
|
knowledge |
Object of Knowledge |
可选 |
{ “dataset_ids”: [ “738509371792341****” ], “auto_call”: true, “search_strategy”: 1 } } |
智能体的知识库配置。 说明
|
| plugin_id_list | Object of PluginIdList | 可选 | {“id_list”:[{“plugin_id”:“731198934927553****”,“api_id”:“735057536617362****”}]} | 智能体的插件配置列表,用于绑定插件及其工具。 |
| workflow_id_list | Object of WorkflowIdList | 可选 | {“ids”: [{“id”: “746049108611037****”}]} | 智能体绑定的工作流 ID 列表,用于配置智能体的工作流。 |
|
model_info_config |
Object of ModelInfoConfig |
可选 |
{ “model_id”: “1706077826” } |
智能体的模型配置,用于指定智能体使用的模型及其相关参数。 模型支持的配置参数及取值范围、默认值各不相同,可在扣子编程中查看具体模型的参数及取值范围。 |
| suggest_reply_info | Object of SuggestReplyInfo | 可选 | {“reply_mode”:“enable”} | 配置智能体回复后的用户问题建议功能。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
prompt |
String |
可选 |
你是一位经验丰富的中餐大厨,能够熟练传授各类中餐的烹饪技巧,每日为大学生厨师小白教学一道经典中餐的制作方法。 |
智能体的人设与回复逻辑。长度为 0~ 20,000 个字符。默认为空。 开启前缀缓存后,不支持通过 |
|
prompt_mode |
String |
可选 |
standard |
提示词模式,用于指定智能体的人设与回复逻辑的配置方式。枚举值:
|
| prefix_prompt_info | Object of PrefixPromptInfo | 可选 | \ | 通过 cache_type 或 parameters.caching.type开启前缀缓存后,你需要通过该参数设置缓存提示词(prefix_prompt)和 非缓存提示词(dynamic_prompt)。不支持通过 prompt 参数设置提示词。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
| prefix_prompt | String | 可选 | \ | 缓存提示词,大量重复出现的固定规则、模板框架或背景信息,用于指引大模型输出格式与风格。扣子编程会将其缓存并复用,大模型无需重新解析这部分固定信息。 |
| dynamic_prompt | String | 可选 | \ | 非缓存提示词,动态变化的个性化信息,仅针对当前请求生效。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
prologue |
String |
可选 |
欢迎你,学徒,今天想学一道什么样的菜? |
智能体的开场白。长度为 0~ 300 个字符。默认无开场白。 开场白中如果设置了用户名称变量 |
| suggested_questions | Array of String | 可选 | [“川菜,我想吃辣的”,“广东菜,来点鲜的”,“随机教我一道菜”] | 智能体的开场白预置问题。每个问题长度为 0~ 50 个字符,问题数量无限制。默认无开场白预置问题。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
dataset_ids |
Array of String |
可选 |
[“738509371792341****”] |
智能体绑定的知识库 ID。 在扣子编程中打开指定知识库页面,页面 URL 中 说明
|
|
auto_call |
Boolean |
可选 |
true |
是否自动调用知识库。取值包括:
|
|
search_strategy |
Integer |
可选 |
1 |
知识库搜索策略。取值包括:
|
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
| id_list | Array of PluginIdInfo | 可选 | { “id_list”: [ { “plugin_id”: “731198934927553****”, “api_id”: “735057536617362****” } ] } | 智能体的插件列表配置。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
api_id |
String |
必选 |
735057536617362**** |
智能体绑定的插件工具 ID。 在扣子编程中,打开资源库页面,选择目标插件,单击插件下的任意工具,页面 URL 中 tool 参数后的数字是插件工具 ID。例如 |
|
plugin_id |
String |
必选 |
731198934927553**** |
智能体绑定的插件 ID。 在扣子编程中,打开资源库页面,选择目标插件,页面 URL 中 plugin 参数后的数字是插件 ID。例如
|
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
| ids | Array of WorkflowIdInfo | 可选 | [ { “id”: “746049108611037****” }] | 智能体的工作流列表配置。 |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
id |
String |
必选 |
746049108611037**** |
智能体绑定的工作流 ID。 进入工作流的编排页面,在页面 URL 中, |
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
model_id |
String |
必选 |
1706077826 |
智能体绑定的模型 ID。 在工作空间的模型管理页面中单击指定模型,模型详情页面 URL 中 |
| top_k | Integer | 可选 | 50 | 生成文本时,采样候选集的大小。该参数控制模型在生成每个词时考虑的候选词数量,值越小生成的文本越保守和确定,值越大生成的文本越多样和随机。 |
|
top_p |
Double |
可选 |
1 |
Top P,即累计概率。该参数控制模型在生成文本时的采样策略,值越小生成的文本越保守和确定,值越大生成的文本越多样和随机。 说明 部分模型不支持该参数,具体支持的模型请参见模型能力差异。 |
| max_tokens | Integer | 可选 | 4096 | 最大回复长度。 |
|
temperature |
Double |
可选 |
1 |
生成随机性。 说明 部分模型不支持该参数,具体支持的模型请参见模型能力差异。 |
|
sp_anti_leak |
Boolean |
可选 |
true |
是否启用 SP 拼接防泄露指令,开启后,当用户尝试获取或复述系统内部的规则、提示词或其他敏感内容时,智能体将礼貌地拒绝用户的请求,确保机密信息不被泄露。
|
| context_round | Integer | 可选 | 30 | 携带上下文轮数。 |
|
response_format |
String |
可选 |
text |
输出格式。取值:
|
|
sp_current_time |
Boolean |
可选 |
true |
是否在 SP 中包含当前时间信息。
|
| presence_penalty | Double | 可选 | 0 | 重复主题惩罚。 |
| frequency_penalty | Double | 可选 | 0 | 重复语句惩罚。 |
|
cache_type |
String |
可选 |
closed |
为模型开启或关闭前缀缓存。开启前缀缓存后,扣子编程将自动缓存公共前缀内容,后续调用模型时无需重复发送,从而加快模型的响应速度并降低使用成本。具体用法请参见前缀缓存。枚举值:
说明
|
|
api_mode |
String |
可选 |
chat_api |
模型的 API 协议类型,用于指定智能体与模型交互时使用的 API 协议。枚举值:
说明 仅部分模型支持 |
|
parameters |
JSON Map |
可选 |
深度思考示例: {“thinking_type”: “disabled”} 上下文管理示例: {“caching”:{“type”:“disabled”},“store”:true,“caching_expire_time”:259200} |
你可以通过该参数配置模型深度思考和
深度思考
上下文管理的具体参数如下:
|
| 参数 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
|
reply_mode |
String |
可选 |
enable |
配置智能体回复后,是否提供用户问题建议。枚举值:
|
| customized_prompt | String | 可选 | 问题应该与你最后一轮的回复紧密相关,可以引发进一步的讨论。 | 关于用户问题建议的 Prompt。当 reply_mode 设置为 customized时,需要设置提示词内容。智能体会根据该提示词生成用户问题建议。 |
| 参数 | 类型 | 示例 | 说明 |
|---|---|---|---|
|
code |
Long |
0 |
调用状态码。
|
|
msg |
String |
“” |
状态信息。API 调用失败时可通过此字段查看详细错误信息。 状态码为 0 时,msg 默认为空。 |
| detail | Object of ResponseDetail | { “logid”: “20250106172024B5F607030EFFAD653960” } | 响应详情信息。 |
| 参数 | 类型 | 示例 | 说明 |
|---|---|---|---|
| logid | String | 20241210152726467C48D89D6DB2**** | 本次请求的日志 ID。如果遇到异常报错场景,且反复重试仍然报错,可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。 |
curl --location --request POST 'https://api.coze.cn/v1/bot/update' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
{
"bot_id": "73428668*****",
"name": "每日学一菜",
"description": "每天教你一道菜的做法,暑假之后你将成为中餐大厨~",
"icon_file_id": "73694959811****",
"prompt_info": {
"prompt": "你是一位经验丰富的中餐大厨,能够熟练传授各类中餐的烹饪技巧,每日为大学生厨师小白教学一道经典中餐的制作方法。"
},
"plugin_id_list": {
"id_list": [
{
"plugin_id": "731198934927553****",
"api_id": "735057536617362****"
}
]
},
"onboarding_info": {
"prologue": "欢迎你,学徒,今天想学一道什么样的菜?",
"suggested_questions": [
"川菜,我想吃辣的",
"广东菜,来点鲜的",
"随机教我一道菜"
]
},
"knowledge": {
"dataset_ids": [
"738509371792341****"
],
"auto_call": true,
"search_strategy": 1
},
"model_info_config": {
"model_id": "1706077826"
},
"workflow_id_list": {
"ids": [
{
"id": "746049108611037****"
}
]
}
}
{
"code": 0,
"msg": "",
"detail": {
"logid": "20241210152726467C48D89D6DB2****"
}
}
如果成功调用扣子编程的 API,返回信息中 code 字段为 0。如果状态码为其他值,则表示接口调用失败。此时 msg 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。