API 参考
实时 WebSocket
调用 NeonAPI 所需的接口、请求参数与响应结构。
GET /v1/realtime
身份验证
将 NeonAPI 密钥放入 Authorization: Bearer YOUR_API_KEY 请求头,在可信应用环境中保管密钥。
可用性与兼容性
调用前核对模型的协议、权限、报价和支持参数。不支持的参数可能被拒绝。示例中的密钥与模型均为占位符。
路径与查询参数
| 字段 | In | 类型 | 必填 |
|---|---|---|---|
model | query | string | 否 |
请求参数
不需要请求体。
请求示例
从可信服务端连接 wss://neon-api.com/v1/realtime?model=YOUR_MODEL_ID,并携带 Authorization 请求头。这是 WebSocket 升级,不是普通 JSON 或 SSE 请求。请使用兼容的 Realtime 客户端及模型支持的事件协议,不要在浏览器代码中嵌入长期密钥。
响应说明
实际字段因模型与协议而异。下方结构描述文档中的成功响应;流式请求使用对应协议的事件。
| 状态码 | 含义 |
|---|---|
| 101 | WebSocket 协议升级 |
| 400 | 请求参数错误 |