Skip to content

串流與 WebSocket ​

Codex Relay 支援一般 HTTP、SSE 串流回應,以及相容用戶端使用的 Responses WebSocket 入口。

SSE 串流回應 ​

在請求內容中設定:

json
{
  "stream": true
}

使用 curl 時加入 -N,避免本機緩衝:

bash
curl -N https://codexapi.asia/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_ID",
    "input": "Count from one to five.",
    "stream": true
  }'

串流模式能更早顯示首批內容,但不會降低模型本身的計算時間。

WebSocket ​

Responses WebSocket 使用:

text
wss://codexapi.asia/v1/responses

只有在用戶端明確支援 Responses WebSocket 時才開啟。一般 OpenAI SDK 與 Chat Completions 用戶端通常使用 HTTP/SSE。

代理注意事項 ​

  • Cloudflare 與反向代理必須允許長連線與 WebSocket Upgrade。
  • 用戶端逾時應涵蓋模型排隊、推理與工具呼叫時間。
  • 不要快取 /v1/* API 回應。
  • 連線中斷後,只重試可安全重新送出的請求。

如何選擇 ​

模式適合場景
非串流 HTTP腳本、短請求、需要一次性 JSON
SSE聊天、Codex、OpenAI SDK 與長文字生成
WebSocket明確實作 Responses WS 的用戶端與連續工作階段