OpenAI 取消 ChatKit 会话
post /chatkit/sessions/{session_id}/cancel
取消一个处于活动状态的 ChatKit 会话,并返回最新的会话元数据。
取消后,已签发的客户端密钥无法用于新的请求。
路径参数
session_id: string
要取消的 ChatKit 会话的唯一标识符。
返回值
ChatSession object { id, chatkit_configuration, client_secret, 7 more }
ChatKit 会话及其生效配置。
id: string
ChatKit 会话的标识符。
chatkit_configuration: ChatSessionChatKitConfiguration
本次会话生效的 ChatKit 功能配置。
automatic_thread_titling: ChatSessionAutomaticThreadTitling
自动生成线程标题的设置。
enabled: boolean
是否启用自动生成线程标题。
file_upload: ChatSessionFileUpload
会话的上传设置。
enabled: boolean
是否允许在本次会话中上传文件。
max_file_size: integer or null
单个上传文件的大小上限,单位为 MB。
max_files: integer or null
本次会话允许上传的文件数量上限。
history: ChatSessionHistory
聊天记录保留设置。
enabled: boolean
本次会话是否持久保留聊天记录。
recent_threads: integer or null
历史记录视图中可显示的既往线程数。保留全部历史时默认为 null。
client_secret: string
用于验证会话请求的临时客户端密钥。
expires_at: integer
会话到期的 Unix 时间戳,单位为秒。
format: unixtime
max_requests_per_1_minute: integer
每分钟请求上限的副本,便于直接读取。
object: "chatkit.session" (default: "chatkit.session")
对象类型,固定为 chatkit.session。
"chatkit.session"
rate_limits: ChatSessionRateLimits
实际生效的速率限制。
max_requests_per_1_minute: integer
每个一分钟时间窗口内允许的最大请求数。
status: ChatSessionStatus
会话当前的生命周期状态。
"active"
"expired"
"cancelled"
user: string
与会话关联的用户标识符。
workflow: ChatKitWorkflow
会话所用工作流的元数据。
id: string
为该会话提供支持的工作流标识符。
state_variables: map[string or number or boolean or number] or null
调用工作流时应用的状态变量键值对。未提供覆盖值时默认为 null。
string
number
boolean
number
tracing: object { enabled }
应用于工作流的追踪设置。
enabled: boolean
是否启用追踪。
version: string or null
会话使用的具体工作流版本。使用最新部署版本时默认为 null。
请求示例
## 在服务端设置 OPENAI_API_KEY 环境变量。
## 将会话 ID 替换为要取消的 ChatKit 会话 ID。
curl https://api.openai.com/v1/chatkit/sessions/$SESSION_ID/cancel \
-X POST \
-H 'OpenAI-Beta: chatkit_beta=v1' \
-H "Authorization: Bearer $OPENAI_API_KEY"
200 响应示例
{
"id": "cksess_123",
"object": "chatkit.session",
"client_secret": "",
"expires_at": 1712349876,
"workflow": {
"id": "workflow_alpha",
"version": "2024-10-01",
"state_variables": {
"message": "你好"
},
"tracing": {
"enabled": true
}
},
"user": "user_789",
"rate_limits": {
"max_requests_per_1_minute": 60
},
"max_requests_per_1_minute": 60,
"status": "cancelled",
"chatkit_configuration": {
"automatic_thread_titling": {
"enabled": true
},
"file_upload": {
"enabled": true,
"max_file_size": 16,
"max_files": 20
},
"history": {
"enabled": true,
"recent_threads": 10
}
}
}
请求示例
## 在服务端设置 OPENAI_API_KEY 环境变量。
## 将会话 ID 替换为要取消的 ChatKit 会话 ID。
curl -X POST \
https://api.openai.com/v1/chatkit/sessions/cksess_123/cancel \
-H "OpenAI-Beta: chatkit_beta=v1" \
-H "Authorization: Bearer $OPENAI_API_KEY"
响应示例
{
"id": "cksess_123",
"object": "chatkit.session",
"client_secret": "",
"expires_at": 1735689600,
"workflow": {
"id": "workflow_alpha",
"version": null,
"state_variables": null,
"tracing": {
"enabled": true
}
},
"user": "user_123",
"rate_limits": {
"max_requests_per_1_minute": 10
},
"max_requests_per_1_minute": 10,
"status": "cancelled",
"chatkit_configuration": {
"automatic_thread_titling": {
"enabled": true
},
"file_upload": {
"enabled": false,
"max_file_size": 512,
"max_files": 10
},
"history": {
"enabled": true,
"recent_threads": null
}
}
}
成功响应中的 status 可用于核对会话是否为 cancelled。

TRAE-AI编程


更多建议: