请求方式	PUT
请求地址	`https://api.coze.cn/v1/datasets/:dataset_id/images/:document_id`
权限	`updatePhoto` 确保调用该接口使用的访问令牌开通了 `updatePhoto` 权限，详细信息参考鉴权方式。
接口说明	调用此接口更新扣子知识库中图片的描述信息。

请求参数

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

Path

参数	类型	是否必选	示例	说明
document_id	String	必选	744667080521909****	待更新描述的图片 ID。
dataset_id	String	必选	“744632974166804****”	知识库 ID。在扣子编程中打开指定知识库页面，页面 URL 中 `knowledge` 参数后的数字就是知识库 ID。例如 `https://bots.bytedance.net/space/736142423532160**/knowledge/738509371792341`，知识库 ID 为 `738509371792341**`。

Body

参数	类型	是否必选	示例	说明
caption	String	必选	小猫	图片的描述信息。

返回参数

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

ResponseDetail

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

示例

请求示例

curl --location --request PUT 'https://api.coze.cn/v1/datasets/744632265564659****/images/744667080521911****' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caption": "小猫"
}'

返回示例

{
  "msg": "",
  "detail": {
    "logid": "202412101551329A18A4BFB***"
  },
  "code": 0
}

错误码

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