OpenAI ChatKit 接口总览

2026-11-20 13:55 更新

ChatKit 接口分为会话和线程两组。会话用于签发或取消客户端密钥。线程接口用于读取或删除对话,以及分页查询线程中的条目。

会话接口

详见 会话接口与状态。

请求 接口参考 用途
POST /chatkit/sessions 创建 ChatKit 会话 为应用用户创建会话并取得客户端密钥。
POST /chatkit/sessions/{session_id}/cancel 取消 ChatKit 会话 取消会话。已签发的客户端密钥无法再用于新请求。

线程接口

详见 线程接口与条目类型。

请求 接口参考 用途
GET /chatkit/threads/{thread_id} 获取 ChatKit 线程 按 ID 获取线程。
DELETE /chatkit/threads/{thread_id} 删除 ChatKit 线程 按 ID 删除线程。
GET /chatkit/threads 列出 ChatKit 线程 分页列出线程。
GET /chatkit/threads/{thread_id}/items 列出 ChatKit 线程条目 分页读取线程中的消息或其他条目。

ChatKitWorkflow 类型

ChatKit 会话返回的工作流元数据与状态。创建请求中的工作流参数见创建 ChatKit 会话。

  • ChatKitWorkflow object { id, state_variables, tracing, version }
    • id: string。支持此会话的工作流标识符。
    • state_variables: map[string or number or boolean or number] or null。调用工作流时应用的状态变量键值对。未提供覆盖值时为 null。
    • tracing: object { enabled }。应用到工作流的追踪设置。
    • enabled: boolean。表示是否启用了追踪。
    • version: string or null。会话使用的具体工作流版本。使用最新部署时为 null。
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号