NeonAPI Docs
API 參考

即時 WebSocket

呼叫 NeonAPI 所需的端點、請求參數與回應結構。

GET /v1/realtime

身分驗證

將 NeonAPI 金鑰放入 Authorization: Bearer YOUR_API_KEY 請求標頭,在可信應用環境中保管金鑰。

可用性與相容性

呼叫前核對模型的協定、權限、報價與支援參數。不支援的參數可能被拒絕。範例中的金鑰與模型均為佔位符。

路徑與查詢參數

欄位In類型必填
modelquerystring否

請求參數

不需要請求主體。

請求範例

從可信伺服器連線 wss://neon-api.com/v1/realtime?model=YOUR_MODEL_ID,並攜帶 Authorization 請求標頭。這是 WebSocket 升級,不是普通 JSON 或 SSE 請求。請使用相容的 Realtime 用戶端及模型支援的事件協定,不要在瀏覽器程式碼中嵌入長期金鑰。

回應說明

實際欄位因模型與協定而異。下方結構描述文件中的成功回應;串流請求使用對應協定的事件。

狀態碼意義
101WebSocket 協定升級
400請求參數錯誤

下載使用者 OpenAPI 規格

另見常見錯誤與串流回應和非同步任務。