玄枢API

Responses API

OpenAI Responses 的 HTTP、流式与 WebSocket 接入说明。

最后验证日期:

连接与鉴权

统一 OpenAI 兼容 Base URL: https://www.xuanshuapi.com/v1

OpenAI 兼容接口使用 Authorization: Bearer <YOUR_API_KEY>;Claude Messages 也支持 x-api-key: <YOUR_API_KEY>;Gemini v1beta 使用 x-goog-api-key: <YOUR_API_KEY>。

Responses API

POST /v1/responses 用于创建响应;GET /v1/responses 可用于受支持客户端的 WebSocket 升级。

具体模型与高级能力以当前控制台配置为准。

请求体与调用

Responses 使用 input 字段,可发送字符串或结构化输入,并可启用 stream。

curl https://www.xuanshuapi.com/v1/responses \
  -H "Authorization: Bearer <YOUR_API_KEY>" -H "content-type: application/json" \
  -d '{"model":"<MODEL_FROM_MODELS>","input":"Reply with OK","stream":false}'

响应与流式行为

完成响应包含 status 与 output;stream=true 时消费响应事件,WebSocket upgrade 需单独处理连接状态。

HTTP 200
{"object":"response","status":"completed","output":[{"type":"message","role":"assistant","content":[{"type":"output_text","text":"OK"}]}]}

关键参数

参数说明
model当前 Key 可见且支持 Responses 的模型。
input字符串或结构化输入。
stream启用响应事件流。

典型故障

400 常见于 input 或参数不兼容;401/403 检查 Key 与权限;426 表示 WebSocket upgrade 不正确。

HTTP 400  # invalid input or parameter
HTTP 401/403  # authentication or permission
HTTP 426  # WebSocket upgrade required or invalid
HTTP 429/5xx  # bounded retry candidate

下一步

可用模型、倍率、配额及部分高级能力动态依赖当前 Key 与控制台配置。