* 仅适用于智能体提示词中定义的变量，不支持用于智能体的变量，或者传入到工作流中。
* 变量名只支持英文字母和下划线。
| | auto_save_history
| Boolean
| 可选 | 是否保存本次对话记录。
* true：（默认）会话中保存本次对话记录，包括 additional_messages 中指定的所有消息、本次对话的模型回复结果、模型执行中间结果。
* false：会话中不保存本次对话记录，后续也无法通过任何方式查看本次对话信息、消息详情。在同一个会话中再次发起对话时，本次会话也不会作为上下文传递给模型。
* 非流式响应下（stream=false），此参数必须设置为 true，即保存本次对话记录，否则无法查看对话状态和模型回复。
* 调用端插件时，此参数必须设置为 true，即保存本次对话记录，否则调用[提交工具执行结果](https://docs.coze.cn/api/open/docs/developer_guides/chat_submit_tool_outputs)时会提示 5000 错误，端插件的详细 API 使用示例请参见[通过 API 使用端插件](https://docs.coze.cn/api/open/docs/guides/use_local_plugin)。
| | meta_data | Map | 可选 | 附加信息，通常用于封装一些业务相关的字段。[查看对话详情](https://www.coze.cn/open/docs/developer_guides/retrieve_chat)时，扣子编程会透传此附加信息，[查看消息列表](https://www.coze.cn/open/docs/developer_guides/list_message)时不会返回该附加信息。
自定义键值对，应指定为 Map 对象格式。长度为 16 对键值对，其中键（key）的长度范围为 1～64 个字符，值（value）的长度范围为 1～512 个字符。 | | extra_params | Map
自定义键值对格式，其中键（key）仅支持设置为：
* latitude：纬度，此时值（Value）为纬度值，例如 39.9800718。
* longitude：经度，此时值（Value）为经度值，例如 116.309314。 | | shortcut_command | Object | 可选 | 快捷指令信息。你可以通过此参数指定此次对话执行的快捷指令，必须是智能体已绑定的快捷指令。
消息结构可参考 **ShortcutCommandDetail Object**。
调用快捷指令，会自动根据快捷指令配置信息生成本次对话中的用户问题，并放入 additional_messages 最后一条消息作为本次对话的用户输入。
| | parameters | Map[String, Any] | 可选 | 给自定义参数赋值并传给对话流。你可以根据实际业务需求，在对话流开始节点的输入参数中设置自定义参数，调用本接口发起对话时，可以通过`parameters` 参数传入自定义参数的值并传给对话流。具体示例代码请参见[给自定义参数赋值](https://docs.coze.cn/api/open/docs/developer_guides/chat_v3#022e2f67)。
仅支持为已发布 API、ChatSDK 的单 Agent（对话流模式）的智能体设置该参数。
| | enable_card
| Boolean
| 可选
| 设置问答节点返回的内容是否为卡片形式。默认为 `false`。
* `true`：问答节点返回卡片形式的内容。
* API 渠道暂时不支持直接渲染卡片交互形式。仅在 Chat SDK 中支持呈现智能体的卡片交互。
* 如果需要实现卡片内容展示，你可以在该 API 响应中获取卡片数据，在 Card SDK 的 `runtimeOptions.dsl` 中引用 API 返回的卡片 data 字段，通过 Card SDK 进行解析并将卡片数据转换为可视化界面，具体请参见[安装并使用 Card SDK](https://docs.coze.cn/api/open/docs/developer_guides/card_sdk)。
* `false`：问答节点返回普通文本形式的内容。 | | publish_status | String | 可选 | 智能体的发布状态，用于指定与已发布版本或草稿版本的智能体对话。默认值为 `published_online`。枚举值：
* `published_online`：与已发布的线上版本的智能体对话。
* `unpublished_draft`：与草稿版本的智能体对话。 | | bot_version | String | 可选 | 指定智能体的版本号，用于与历史版本的智能体进行对话。默认与最新版本的智能体对话。
你可以通过[查看智能体版本列表](https://www.coze.cn/open/docs/developer_guides/list_bot_versions) API 查看智能体的版本号。
当 `publish_status` 设置为 `unpublished_draft`时，填写此参数会提示 4000 错误。 | ## EnterMessage Object | **参数** | **类型** | **是否必选** | **说明** | | --- | --- | --- | --- | | role | String | 必选 | 发送这条消息的实体。取值：
* **user**：代表该条消息内容是用户发送的。
* **assistant**：代表该条消息内容是智能体发送的。 | | type
| String | 可选
| 消息类型。默认为 **question。**
* **question**：用户输入内容。
* **answer**：智能体返回给用户的消息内容，支持增量返回。如果工作流绑定了输出节点，可能会存在多 answer 场景，此时可以用流式返回的结束标志来判断所有 answer 完成。
* **function_call**：智能体对话过程中调用函数（function call）的中间结果。
* **tool_response**：调用工具 （function call）后返回的结果。
* **follow_up**：如果在 智能体上配置打开了用户问题建议开关，则会返回推荐问题相关的回复内容。不支持在请求中作为入参。
* **verbose**：多 answer 场景下，服务端会返回一个 verbose 包，对应的 content 为 JSON 格式，`content.msg_type =generate_answer_finish` 代表全部 answer 回复完成。不支持在请求中作为入参。
仅发起会话（v3）接口支持将此参数作为入参，且：
* 如果 autoSaveHistory=true，type 支持设置为 question 或 answer。
* 如果 autoSaveHistory=false，type 支持设置为 question、answer、function_call、tool_output/tool_response。
其中，type=question 只能和 role=user 对应，即仅用户角色可以且只能发起 question 类型的消息。详细说明可参考[消息 type 说明](https://docs.coze.cn/api/open/docs/developer_guides/message_type)。
| | content | String | 必选 | 消息的内容，支持纯文本、多模态（文本、图片、文件混合输入）、卡片等多种类型的内容。
* content_type 为 object_string 时，content 为 **object_string object** 数组序列化之后的 JSON String，详细说明可参考 **object_string object。**
* 当 content_type **=** text **** 时，content 为普通文本，例如 `"content" :"Hello!"`。 | | content_type | String | 必选 | 消息内容的类型，支持设置为：
* text：文本。
* object_string：多模态内容，即文本和文件的组合、文本和图片的组合。
* card：卡片。此枚举值仅在接口响应中出现，不支持作为入参。
content 不为空时，此参数为必选。
| | meta_data | Map | 可选 | 创建消息时的附加消息，[查看消息列表](https://www.coze.cn/open/docs/developer_guides/list_message)时也会返回此附加消息。
自定义键值对，应指定为 Map 对象格式。长度为 16 对键值对，其中键（key）的长度范围为 1～64 个字符，值（value）的长度范围为 1～512 个字符。 | #### object_string object | **参数** | **类型** | **是否必选** | **说明** | | --- | --- | --- | --- | | type | String | 必选 | 多模态消息内容类型，支持设置为：
* text：文本类型。
* file：文件类型。
* image：图片类型。
* audio：音频类型。 | | text | String | 可选 | 文本内容。 | | file_id | String | 可选 | 文件、图片、音频内容的 ID。
* 必须是当前账号上传的文件 ID，上传方式可参考[上传文件](https://docs.coze.cn/api/open/docs/developer_guides/upload_files)。
* 在 type 为 file、image 或 audio 时，file_id 和 file_url 应至少指定一个。
| | file_url | String | 可选 | 文件、图片或语音文件的在线地址。必须是可公共访问的有效地址。
在 type 为 file、image 或 audio 时，file_id 和 file_url 应至少指定一个。 | * 一个 object_string 数组中最多包含一条 `text` 类型消息，但可以包含多个 `file`、`image` 类型的消息。 * 当 object_string 数组中存在 `text` 类型消息时，必须同时存在至少 1 条 `file` 或 `image` 消息，纯文本消息（仅包含 `text` 类型）需要使用 `content_type: text` 字段直接指定，不能使用 `object_string` 数组。 * 支持发送纯图片或纯文件消息，但每条纯图片或纯文件消息的前一条或后一条消息中，必须包含一条 `content_type: text` 的纯文本消息，作为用户查询的上下文。例如， `"content": "[{\"type\":\"image\",\"file_id\":\"112233***\"}]"` 为一条纯图片消息，该纯图片消息的前一条或后一条消息必须是一条纯文本消息，否则接口会报 4000 参数错误。 例如，以下数组是一个完整的多模态内容：
序列化前：
```JSON
[
{
"type": "text",
"text": "你好我有一个帽衫，我想问问它好看么，你帮我看看"
}, {
"type": "image",
"file_id": "112233***"
}, {
"type": "file",
"file_id": "144423***"
},
{
"type": "file",
"file_url": "https://example.com/tos-cn-i-mdko3gqilj/example.png"
}
]
```
序列化后：
```JSON
"[{\"type\":\"text\",\"text\":\"你好我有一个帽衫，我想问问它好看么，你帮我看看\"},{\"type\":\"image\",\"file_id\":\"112233***\"},{\"type\":\"file\",\"file_id\":\"144423***\"},{\"type\":\"file\",\"file_url\":\"https://example.com/tos-cn-i-mdko3gqilj/example.png\"}]"
```
文本消息的 content_type 为 text，消息结构示例如下。
```JSON
{
"role": "user",
"content": "搜几个最新的军事新闻",
"content_type": "text"
}
```
多模态消息的 content_type 为 object_string，消息结构示例如下。
```JSON
{
"role": "user",
"content": "[{\"type\":\"text\",\"text\":\"你好我有一个帽衫，我想问问它好看么，你帮我看看\"},{\"type\":\"image\",\"file_id\":\"112233***\"},{\"type\":\"file\",\"file_id\":\"144423***\"}]",
"content_type": "object_string"
}
```
若对话无需执行快捷指令时，无需设置此参数。
你可以通过[查看智能体配置](https://docs.coze.cn/api/open/docs/developer_guides/get_metadata_draft_published) API 中的[ShortcutCommandInfo](https://docs.coze.cn/api/open/docs/developer_guides/get_metadata_draft_published#shortcutcommandinfo)查看快捷指令 ID。 | | parameters | Map
自定义键值对，其中键（key）为快捷指令组件的名称，值（value）为组件对应的用户输入，为 **object_string object** 数组序列化之后的 JSON String，详细说明可参考 **object_string object。** | # 返回结果 此接口通过请求 Body 参数 stream 为 true 或 false 来指定 Response 为流式或非流式响应。你可以根据以下步骤判断当前业务场景适合的响应模式。
## 流式响应
在流式响应中，服务端不会一次性发送所有数据，而是以数据流的形式逐条发送数据给客户端，数据流中包含对话过程中触发的各种事件（event），直至处理完毕或处理中断。处理结束后，服务端会通过 conversation.message.completed 事件返回拼接后完整的模型回复信息。各个事件的说明可参考**流式响应事件**。
流式响应允许客户端在接收到完整的数据流之前就开始处理数据，例如在对话界面实时展示智能体的回复内容，减少客户端等待模型完整回复的时间。
流式响应的整体流程如下：
```JSON
######### 整体概览 （chat, MESSAGE 两级）
# chat - 开始
# chat - 处理中
# MESSAGE - 知识库召回
# MESSAGE - function_call
# MESSAGE - tool_output
# MESSAGE - answer is card
# MESSAGE - answer is normal text
# MESSAGE - 多 answer 的情况下，会继续有 message.delta
# MESSAGE - verbose （多 answer、Multi-agent 跳转等场景）
# MESSAGE - suggestion
# chat - 完成
# 流结束 event: done
#########
```
```JSON
# chat - 开始
event: conversation.chat.created
// 在 chat 事件里，data 字段中的 id 为 Chat ID，即会话 ID。
data: {"id": "123", "conversation_id":"123", "bot_id":"222", "created_at":1710348675,compleated_at:null, "last_error": null, "meta_data": {}, "status": "created","usage":null}
# chat - 处理中
event: conversation.chat.in_progress
data: {"id": "123", "conversation_id":"123", "bot_id":"222", "created_at":1710348675, compleated_at: null, "last_error": null,"meta_data": {}, "status": "in_progress","usage":null}
# MESSAGE - 知识库召回
event: conversation.message.completed
data: {"id": "msg_001", "role":"assistant","type":"knowledge","content":"---\nrecall slice 1:xxxxxxx\n","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - function_call
event: conversation.message.completed
data: {"id": "msg_002", "role":"assistant","type":"function_call","content":"{\"name\":\"toutiaosousuo-search\",\"arguments\":{\"cursor\":0,\"input_query\":\"今天的体育新闻\",\"plugin_id\":7281192623887548473,\"api_id\":7288907006982012986,\"plugin_type\":1","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - toolOutput
event: conversation.message.completed
data: {"id": "msg_003", "role":"assistant","type":"tool_output","content":"........","content_type":"card","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - answer is card
event: conversation.message.completed
data: {"id": "msg_004", "role":"assistant","type":"answer","content":"{{card_json}}","content_type":"card","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - answer is normal text
event: conversation.message.delta
data:{"id": "msg_005", "role":"assistant","type":"answer","content":"以下","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
event: conversation.message.delta
data:{"id": "msg_005", "role":"assistant","type":"answer","content":"是","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
...... {{ N 个 delta 消息包}} ......
event: conversation.message.completed
data:{"id": "msg_005", "role":"assistant","type":"answer","content":"{{msg_005 完整的结果。即之前所有 msg_005 delta 内容拼接的结果}}","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - 多 answer 的情况,会继续有 message.delta
event: conversation.message.delta
data:{"id": "msg_006", "role":"assistant","type":"answer","content":"你好你好","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
...... {{ N 个 delta 消息包}} ......
event: conversation.message.completed
data:{"id": "msg_006", "role":"assistant","type":"answer","content":"{{msg_006 完整的结果。即之前所有 msg_006 delta 内容拼接的结果}}","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - Verbose （流式 plugin, 多 answer 结束，Multi-agent 跳转等场景）
event: conversation.message.completed
data:{"id": "msg_007", "role":"assistant","type":"verbose","content":"{\"msg_type\":\"generate_answer_finish\",\"data\":\"\"}","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# MESSAGE - suggestion
event: conversation.message.completed
data: {"id": "msg_008", "role":"assistant","type":"follow_up","content":"朗尼克的报价是否会成功？","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
event: conversation.message.completed
data: {"id": "msg_009", "role":"assistant","type":"follow_up","content":"中国足球能否出现？","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
event: conversation.message.completed
data: {"id": "msg_010", "role":"assistant","type":"follow_up","content":"羽毛球种子选手都有谁？","content_type":"text","chat_id": "123", "conversation_id":"123", "bot_id":"222"}
# chat - 完成
event: conversation.chat.completed （chat完成）
data: {"id": "123", "chat_id": "123", "conversation_id":"123", "bot_id":"222", "created_at":1710348675, compleated_at:1710348675, "last_error":null, "meta_data": {}, "status": "compleated", "usage":{"token_count":3397,"output_tokens":1173,"input_tokens":2224}}
event: done （stream流结束）
data: [DONE]
# chat - 失败
event: conversation.chat.failed
data: {
"code":701231,
"msg":"error"
}
```
* chat 事件中，data 为 **Chat** **Object**。
* message、audio 事件中，data 为 **Message** **Object**。 | ## **流式响应事件** | **事件（event）名称** | **说明** | | --- | --- | | conversation.chat.created | 创建对话的事件，表示对话开始。 | | conversation.chat.in_progress | 服务端正在处理对话。 | | conversation.message.delta | 增量消息，通常是 type=answer 时的增量消息。 | | conversation.audio.delta | 增量语音消息，通常是 type=answer 时的增量消息。只有输入中包含语音消息时，才会返回 audio.delta。 | | conversation.message.completed | message 已回复完成。此时流式包中带有所有 message.delta 的拼接结果，且每个消息均为 completed 状态。 | | conversation.chat.completed | 对话完成。 | | conversation.chat.failed | 此事件用于标识对话失败。 | | conversation.chat.requires_action | 对话中断，需要使用方上报工具的执行结果。 | | error | 流式响应过程中的错误事件。关于 code 和 msg 的详细说明，可参考[错误码](https://docs.coze.cn/api/open/docs/developer_guides/coze_error_codes)。 | | done | 本次会话的流式返回正常结束。 | ## 非流式响应 在非流式响应中，无论服务端是否处理完毕，立即发送响应消息。其中包括本次对话的 chat_id、状态等元数据信息，但不包括模型处理的最终结果。 非流式响应不需要维持长连接，在场景实现上更简单，但通常需要客户端主动查询对话状态和消息详情才能得到完整的数据。你可以通过接口[查看对话详情](https://docs.coze.cn/api/open/docs/developer_guides/retrieve_chat)确认本次对话处理结束后，再调用[查看对话消息详情](https://docs.coze.cn/api/open/docs/developer_guides/list_chat_messages)接口查看模型回复等完整响应内容。流程如下：  非流式响应的结构如下： | **参数** | **类型** | **说明** | | --- | --- | --- | | data | Object | 本次对话的基本信息。详细说明可参考 **Chat** **Object**。 | | code | Integer | 状态码。
`0` 代表调用成功。 | | msg | String | 状态信息。API 调用失败时可通过此字段查看详细错误信息。 | ## 响应参数 #### Chat Object | 参数 | 类型 | 是否可选 | 说明 | | --- | --- | --- | --- | | id | String | 必填 | 对话 ID，即对话的唯一标识。 | | conversation_id | String | 必填 | 会话 ID，即会话的唯一标识。 | | bot_id | String | 必填 | 要进行会话聊天的智能体 ID。 | | created_at | Integer | 选填 | 对话创建的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。 | | completed_at | Integer | 选填 | 对话结束的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。 | | failed_at | Integer | 选填 | 对话失败的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。 | | meta_data | Map
自定义键值对，应指定为 Map 对象格式。长度为 16 对键值对，其中键（key）的长度范围为 1～64 个字符，值（value）的长度范围为 1～512 个字符。 | | last_error
| Object | 选填 | 对话运行异常时，此字段中返回详细的错误信息，包括：
* Code：错误码。Integer 类型。0 表示成功，其他值表示失败。
* Msg：错误信息。String 类型。
* 对话正常运行时，此字段返回 null。
* suggestion 失败不会被标记为运行异常，不计入 last_error。
| | status
| String | 必填 | 对话的运行状态。取值为：
* created：对话已创建。
* in_progress：智能体正在处理中。
* completed：智能体已完成处理，本次对话结束。
* failed：对话失败。
* requires_action：对话中断，需要进一步处理。
* canceled：对话已取消。 | | required_action | Object | 选填 | 需要运行的信息详情。 | | » type | String | 选填 | 额外操作的类型，枚举值为 submit_tool_outputs。 | | »submit_tool_outputs | Object | 选填 | 需要提交的结果详情，通过提交接口上传，并可以继续聊天 | | »» tool_calls | Array of Object | 选填 | 具体上报信息详情。 | | »»» id | String | 选填 | 上报运行结果的 ID。 | | »»» type | String | 选填 | 工具类型，枚举值包括：
* function：待执行的方法，通常是端插件。触发端插件时会返回此枚举值。
* reply_message：待回复的选项。触发工作流问答节点时会返回此枚举值。 | | »»» function | Object | 选填 | 执行方法 function 的定义。 | | »»»» name | String | 选填 | 方法名。 | | »»»» arguments | String | 选填 | 方法参数。 | | usage | Object | 选填 | Token 消耗的详细信息。实际的 Token 消耗以对话结束后返回的值为准。 | | »token_count | Integer | 选填 | 本次对话消耗的 Token 总数，包括 input 和 output 部分的消耗。 | | »output_count | Integer | 选填 | output 部分消耗的 Token 总数。 | | »input_count | Integer | 选填 | input 部分消耗的 Token 总数。 | Chat Object 的示例如下：
```JSON
{
// 在 chat 事件里，data 字段中的 id 为 Chat ID，即会话 ID。
"id": "737662389258662****",
"conversation_id": "737554565555041****",
"bot_id": "736661612448078****",
"completed_at": 1717508113,
"last_error": {
"code": 0,
"msg": ""
},
"status": "completed",
"usage": {
"token_count": 6644,
"output_count": 766,
"input_count": 5878
}
}
```
```JSON
{
"code": 0,
"data": {
"bot_id": "737282596785517****",
"completed_at": 1717513285,
"conversation_id": "737666232053956****",
"created_at": 1717513283,
// 在 chat 事件里，data 字段中的 id 为 Chat ID，即会话 ID。
"id": "737666232053959****",
"required_action": {
"submit_tool_outputs": {
"tool_calls": [
{
"function": {
"arguments": "{\"location\":\"南京\",\"type\":0}",
"name": "local_data_assistant"
},
"id": "BUJJF0dAQ0NAEBVeQkVKEV5HFURFXhFCEhFeFxdHShcSQEtFSxYRSUI=",
"type": "function"
}
]
},
"type": "submit_tool_outputs"
},
"status": "requires_action"
},
"msg": ""
}
```
* **user**：代表该条消息内容是用户发送的。
* **assistant**：代表该条消息内容是智能体发送的。 | | content | String
| 消息的内容，支持纯文本、多模态（文本、图片、文件混合输入）、卡片等多种类型的内容。
* 当 `role` 为 user 时，支持返回多模态内容。
* 当 `role` 为 assistant 时，只支持返回纯文本内容。
| | content_type | String | 消息内容的类型，取值包括：
* text：文本。
* object_string：多模态内容，即文本和文件的组合、文本和图片的组合。
* card：卡片。此枚举值仅在接口响应中出现，不支持作为入参。
* audio：音频。此枚举值仅在接口响应中出现，不支持作为入参。仅当输入有 audio 文件时，才会返回此类型。当 content_type 为 audio 时，content 为 base64 后的音频数据。音频的编码根据输入的 audio 文件的不同而不同：
* 输入为 wav 格式音频时，content 为**采样率 24kHz，raw 16 bit, 1 channel, little-endian 的 pcm 音频片段 base64 后的字符串**
* 输入为 ogg_opus 格式音频时，content 为**采样率 48kHz，1 channel，10ms 帧长的 opus 格式音频片段base64 后的字符串** | | created_at | Integer | 消息的创建时间，格式为 10 位的 Unixtime 时间戳，单位为秒（s）。 | | updated_at | Integer | 消息的更新时间，格式为 10 位的 Unixtime 时间戳，单位为秒（s）。 | | type | String | 消息类型。
* **question**：用户输入内容。
* **answer**：智能体返回给用户的消息内容，支持增量返回。如果工作流绑定了 messge 节点，可能会存在多 answer 场景，此时可以用流式返回的结束标志来判断所有 answer 完成。
* **function_call**：智能体对话过程中调用函数（function call）的中间结果。
* **tool_response**：调用工具 （function call）后返回的结果。
* **follow_up**：如果在智能体上配置打开了用户问题建议开关，则会返回推荐问题相关的回复内容。
* **verbose**：多 answer 场景下，服务端会返回一个 verbose 包，对应的 content 为 JSON 格式，`content.msg_type =generate_answer_finish` 代表全部 answer 回复完成。
仅发起会话（v3）接口支持将此参数作为入参，且：
* 如果 autoSaveHistory=true，type 支持设置为 question 或 answer。
* 如果 autoSaveHistory=false，type 支持设置为 question、answer、function_call、tool_response。
其中，type=question 只能和 role=user 对应，即仅用户角色可以且只能发起 question 类型的消息。详细说明可参考[消息 type 说明](https://docs.coze.cn/api/open/docs/developer_guides/message_type)。
| | section_id | String | 上下文片段 ID。每次清除上下文都会生成一个新的 section_id。 | | reasoning_content | String | 模型的思维链（CoT），展示模型如何将复杂问题逐步分解为多个简单步骤并推导出最终答案。仅当模型支持深度思考、且智能体开启了深度思考时返回该字段，当前支持深度思考的模型如下：
* 豆包·1.6·自动深度思考·多模态模型
* 豆包·1.6·极致速度·多模态模型
* 豆包·1.5·Pro·视觉深度思考
* 豆包·GUI·Agent模型
* DeepSeek-R1 | # 示例 ## 流式响应
* **Request**
```Shell
curl --location --request POST 'https://api.coze.cn/v3/chat?conversation_id=7374752000116113452' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
"bot_id": "734829333445931****",
"user_id": "123456789",
"stream": true,
"auto_save_history":true,
"additional_messages":[
{
"role":"user",
"content":"2024年10月1日是星期几",
"content_type":"text"
}
]
}'
```
* **Response**
```JSON
event:conversation.chat.created
// 在 chat 事件里，data 字段中的 id 为 Chat ID，即会话 ID。
data:{"id":"7382159487131697202","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792949,"last_error":{"code":0,"msg":""},"status":"created","usage":{"token_count":0,"output_count":0,"input_count":0}}
event:conversation.chat.in_progress
data:{"id":"7382159487131697202","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792949,"last_error":{"code":0,"msg":""},"status":"in_progress","usage":{"token_count":0,"output_count":0,"input_count":0}}
event:conversation.message.delta
data:{"id":"7382159494123470858","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"2","content_type":"text","chat_id":"7382159487131697202"}
event:conversation.message.delta
data:{"id":"7382159494123470858","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"0","content_type":"text","chat_id":"7382159487131697202"}
//省略模型回复的部分中间事件event:conversation.message.delta
......
event:conversation.message.delta
data:{"id":"7382159494123470858","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"星期三","content_type":"text","chat_id":"7382159487131697202"}
event:conversation.message.delta
data:{"id":"7382159494123470858","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"。","content_type":"text","chat_id":"7382159487131697202"}
event:conversation.message.completed
data:{"id":"7382159494123470858","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"2024 年 10 月 1 日是星期三。","content_type":"text","chat_id":"7382159487131697202"}
event:conversation.message.completed
data:{"id":"7382159494123552778","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"verbose","content":"{\"msg_type\":\"generate_answer_finish\",\"data\":\"\",\"from_module\":null,\"from_unit\":null}","content_type":"text","chat_id":"7382159487131697202"}
event:conversation.chat.completed
data:{"id":"7382159487131697202","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792949,"last_error":{"code":0,"msg":""},"status":"completed","usage":{"token_count":633,"output_count":19,"input_count":614}}
event:done
data:"[DONE]"
```
* Request
```Shell
curl --location --request POST 'https://api.coze.cn/v3/chat?conversation_id=7374752000116113452' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
"bot_id": "737946218936519****",
"user_id": "123456789",
"stream": true,
"auto_save_history":true,
"additional_messages":[
{
"role":"user",
"content":"[{\"type\":\"image\",\"file_url\":\"https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png\"},{\"type\":\"text\",\"text\":\"帮我看看这张图片里都有什么\"}]",
"content_type":"object_string"
}
]
}'
```
* Response
```JSON
event:conversation.chat.created
// 在 chat 事件里，data 字段中的 id 为 Chat ID，即会话 ID。
data:{"id":"7382158397837344768","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792697,"last_error":{"code":0,"msg":""},"status":"created","usage":{"token_count":0,"output_count":0,"input_count":0}}
event:conversation.chat.in_progress
data:{"id":"7382158397837344768","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792697,"last_error":{"code":0,"msg":""},"status":"in_progress","usage":{"token_count":0,"output_count":0,"input_count":0}}
event:conversation.message.completed
data:{"id":"7382158491307212815","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"function_call","content":"{\"name\":\"tupianlijie-imgUnderstand\",\"arguments\":{\"text\":\"描述图片里有什么\",\"url\":\"https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png\"},\"plugin_id\":7379227414322217010,\"api_id\":7379227414322233394,\"plugin_type\":1,\"thought\":\"需求为描述图片（https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png）里都有什么，需要调用tupianlijie-imgUnderstand工具理解图片\"}","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.message.completed
data:{"id":"7382158637826998312","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"tool_response","content":"{\"content_type\":1,\"response_for_model\":\" 这幅图像描绘了一片宁静而神秘的森林景象。画面中心是一条蜿蜒流淌的小溪，溪水清澈见底，溪床上散布着几块大小不一的石头。溪流两岸覆盖着厚厚的青苔，与周围的树木形成鲜明对比。树木高大挺拔，树干粗壮，树皮呈深褐色，树枝上长满了翠绿的针叶，阳光透过树叶的缝隙洒在地面上，形成斑驳的光影。整个场景被一层淡淡的雾气笼罩，增添了一丝神秘和幽静的氛围。画面远处的树木逐渐变得模糊，与天空的灰白色融为一体，整个画面色彩以绿色和棕色为主，营造出一种深邃而古老的感觉。整体上，这幅图像传达了一种与自然和谐共处的宁静与平和。\",\"type_for_model\":1}","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"这","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"是","content_type":"text","chat_id":"7382158397837344768"}
//省略模型回复的部分中间事件event:conversation.message.delta
......
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"树木","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"。","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.message.completed
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"这是一幅非常漂亮的森林图片，里面有小溪、石头和青苔覆盖的树木。","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.message.completed
data:{"id":"7382158652519645218","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"verbose","content":"{\"msg_type\":\"generate_answer_finish\",\"data\":\"\",\"from_module\":null,\"from_unit\":null}","content_type":"text","chat_id":"7382158397837344768"}
event:conversation.chat.completed
data:{"id":"7382158397837344768","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792697,"last_error":{"code":0,"msg":""},"status":"completed","usage":{"token_count":2308,"output_count":111,"input_count":2197}}
event:done
data:"[DONE]"
```
* **Request**
```Shell
curl --location --request POST 'https://api.coze.cn/v3/chat?conversation_id=737475200011611****' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
"bot_id": "734829333445931****",
"user_id": "123456789",
"stream": false,
"auto_save_history":true,
"additional_messages":[
{
"role":"user",
"content":"今天杭州天气如何",
"content_type":"text"
}
]
}'
```
* **Response**
```JSON
{
"data":{
// data 字段中的 id 为 Chat ID，即会话 ID。
"id": "123",
"conversation_id": "123456",
"bot_id": "222",
"created_at": 1710348675,
"completed_at": 1710348675,
"last_error": null,
"meta_data": {},
"status": "completed",
"usage": {
"token_count": 3397,
"output_count": 1173,
"input_count": 2224
}
},
"code":0,
"msg":""
}
```
* Request
```Shell
curl --location --request POST 'https://api.coze.cn/v3/chat?conversation_id=737475200011611****' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
"bot_id": "737946218936519****",
"user_id": "123456789",
"stream": false,
"auto_save_history":true,
"additional_messages":[
{
"role":"user",
"content":"[{\"type\":\"image\",\"file_url\":\"https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png\"},{\"type\":\"text\",\"text\":\"帮我看看这张图片里都有什么\"}]",
"content_type":"object_string"
}
]
}'
```
* Response
```JSON
{
"data":{
// data 字段中的 id 为 Chat ID，即会话 ID。
"id": "123",
"conversation_id": "123456",
"bot_id": "222",
"created_at": 1710348675,
"completed_at": 1710348675,
"last_error": null,
"meta_data": {},
"status": "compleated",
"usage": {
"token_count": 3397,
"output_count": 1173,
"input_count": 2224
}
},
"code":0,
"msg":""
}
```
* Request
```Shell
curl --location --request POST 'https://api.coze.cn/v3/chat?conversation_id=737475200011611****' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
"bot_id": "737946218936519****",
"user_id": "123456789",
"stream": false,
"auto_save_history":true,
"additional_messages":[],
"shortcut_command":{
"command_id":"745701083352557****",
"parameters":{
"news_query":"[{\"type\":\"text\",\"text\":\"娱乐新闻\"}]"
}
}
}'
```
* Response
```JSON
{
"data":{
// data 字段中的 id 为 Chat ID，即会话 ID。
"id": "123",
"conversation_id": "123456",
"bot_id": "222",
"created_at": 1710348675,
"completed_at": 1710348675,
"last_error": null,
"meta_data": {},
"status": "compleated",
"usage": {
"token_count": 3397,
"output_count": 1173,
"input_count": 2224
}
},
"code":0,
"msg":""
}
```
智能体Prompt 配置示例：
API 调用示例：
智能体Prompt 配置示例：
API 调用示例：
