API 协议
GET · 实时 WebSocket 连接 · 路由参考
直接答案GET /v1/realtime。仅源码路由参考,尚未完成接入协议核验,不提供可执行示例。
更新 · 审核信息
OpenFox · 实时 WebSocket 连接
GET https://api.openfox.vip/v1/realtime
Model ID: YOUR_MODEL_ID
Authentication
Authorization: Bearer $OPENFOX_API_KEY
Create a model API key in API Keys. Dashboard sessions and personal access tokens are not model API credentials.
Keep credentials in environment variables on your server. Do not paste real keys, cookies or account records into this guide.
Request parameters
- model (query, string, Optional): 要使用的模型
Example values are not server defaults. Model-specific parameter support must be confirmed for the selected channel.
Model and channel limitations
Route present in the source. The complete parameter and result contract has not been verified in this release. Native task routes depend on enabled plugins and channels. No runnable example is generated for this entry.
Request example
Run one language example only. Creation requests may be charged; do not run every example or retry automatically.
Set OPENFOX_REQUEST_ID from the original X-Request-Id when recovering images. Set OPENFOX_TASK_ID from a real task creation response when querying tasks.
This entry is a source reference, not a complete integration guide. Do not generate a request until the protocol contract has been verified.
Results and success criteria
Route existence was checked in source only. Response fields, business success, streaming and asynchronous behavior require protocol-specific verification before use.
Error handling
Check both HTTP status and business errors. A timeout does not prove the operation failed. Do not automatically retry creation requests; inspect the original request or usage first.
401/403: check credentials, scopes, model permissions and IP rules. 429: check quota and rate limits. 5xx: preserve a non-secret request ID and contact support.
Python and JavaScript share a 180-second network deadline. Read-only polling is bounded. Unknown or failure states stop the flow. Image decoding is local CPU work with byte and pixel limits.
Uploads, downloads and related endpoints
Only the image editing example uploads a local file. Set OPENFOX_IMAGE_PATH to a supported image. Other examples do not upload files. Download external results without platform credentials. Task artifacts require format-specific verification.
Full request schema
{
"parameters": [
{
"name": "model",
"in": "query",
"description": "要使用的模型",
"required": false,
"schema": {
"type": "string",
"example": "gpt-4o-realtime-preview"
}
}
],
"requestBody": null
}
Sources and verification
docs/openapi/relay.json · router/relay-router.go · 2026-11-03
SHA-256: aeee6c35a35b2eaced964401f3826f369ad7ac8985c17989dcbbe08337d9fa01
route-source-only; schema-and-business-not-tested; legacy-schema-needs-field-review
Source review is not upstream business verification. Availability and billing depend on your account, group and channel.
适用场景
- getting-started
- troubleshooting
API 协议
/v1/realtime
常见问题
这里是否保证模型可调用?
不保证。请在模型广场核对精确型号、账号分组与端点权限。
示例是否使用真实密钥?
不使用。请在自己的服务端设置环境变量,并将 YOUR_MODEL_ID 替换为可用的精确模型 ID。
接口超时可以立即重试吗?
创建请求不应自动重试。先核对请求编号、任务状态和用量,避免重复收费。
关联指南
官方来源
- OpenFox API 官方