GET /v1/responses WebSocket

接口用途

OpenAI Responses WebSocket 入口，用于双向或长连接式的 Responses 交互。

这也是当前 previous_response_id 续写支持所指向的主要入口。

请求路径

GET /v1/responses
GET /responses
GET /backend-api/codex/responses

认证方式

与 HTTP 版本一致：

• Authorization: Bearer <API_KEY>
• x-api-key: <API_KEY>

连接要求

必须发起 WebSocket Upgrade。

如果用普通 HTTP 访问，会返回：

{
  "error": {
    "type": "invalid_request_error",
    "message": "WebSocket upgrade required (Upgrade: websocket)"
  }
}

上游官方规范

• OpenAI Responses API

本项目支持说明

• 与 HTTP /v1/responses 共用大部分鉴权、调度和计费逻辑
• 连接建立后，首条消息中会解析 previous_response_id
• 如果 previous_response_id 看起来像 message id，会直接关闭连接

参数说明

首条消息仍遵循 Responses API 的请求体形态，常用字段包括：

参数	类型	必填	说明
model	string	通常是	目标模型
stream	boolean	否	WebSocket 下通常按事件流处理
previous_response_id	string	否	WebSocket 场景支持续写能力

完整字段请参考 OpenAI 官方规范。

响应说明

• 成功时建立 WebSocket 连接
• 后续消息按 Responses 事件语义转发

示例

const ws = new WebSocket('wss://your-domain/api/v1/v1/responses', [], {
  headers: {
    Authorization: 'Bearer sk-xxxx'
  }
})

注意事项

• 这是当前支持 previous_response_id 的推荐入口
• 如果客户端只会发送标准 HTTP，不要依赖这项能力