Skip to main content
POST
重命名会话

授权

Authorization
string
header
必填

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

路径参数

conversation_id
string<uuid>
必填

要重命名的会话 ID。会话 ID 可从 获取会话列表 获取。

请求体

application/json
user
string
必填

终端用户标识,由你的应用定义,需在应用内唯一。必须与创建该会话时使用的 user 一致。参见 终端用户身份。

Required string length: 1 - 255
name
string

新的会话名称。除非 auto_generate 为 true,否则必填。名称最多按 255 字节存储。中文等多字节文字写成的长名称会在字符边界处截断后保存,不会报错。

Maximum string length: 255
auto_generate
boolean
默认值:false

根据会话的第一个问题自动生成会话名称。当为 true 时,name 字段将被忽略。自动生成的名称同样会被截断。

响应

更新后的会话,其中的名称是实际存储的值。

id
string

会话 ID。

name
string

会话名称。

inputs
object

创建会话时提交的输入变量。

status
string

固定为 normal。

introduction
string

创建会话时记录的应用开场白,未配置时为空字符串。

created_at
integer

创建时间,Unix 时间戳(秒)。

updated_at
integer

最后更新时间,Unix 时间戳(秒)。