Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
OpenModex API 参考 — 兼容 OpenAI 的端点，附带增强功能。
| 环境 | URL |
|---|---|
| 生产环境 | https://api.openmodex.com/v1 |
| 沙盒环境 | https://api-sandbox.openmodex.com/v1 |
Authorization 头中包含您的 API 密钥：
Authorization: Bearer omx_sk_YOUR_API_KEY
| 方法 | 端点 | 描述 |
|---|---|---|
POST | /chat/completions | 创建聊天补全 |
POST | /completions | 创建文本补全（旧版） |
POST | /embeddings | 创建嵌入 |
GET | /models | 列出可用模型 |
GET | /models/:id | 获取模型详情 |
GET | /models/compare | 并排对比模型 |
POST 请求接受 JSON 格式的请求体，Content-Type: application/json。
{
"error": {
"message": "Human-readable error message",
"type": "invalid_request_error",
"code": "invalid_api_key"
}
}
| 状态码 | 描述 |
|---|---|
200 | 成功 |
400 | 请求错误 — 请检查您的参数 |
401 | 未授权 — API 密钥无效或缺失 |
403 | 禁止 — 权限不足 |
404 | 未找到 — 端点或模型无效 |
429 | 速率限制 — 请降低请求频率或升级套餐 |
500 | 服务器错误 — 请使用退避策略重试 |
502 | 网关错误 — 上游供应商错误 |
503 | 服务不可用 — 临时中断 |
openmodex 字段，提供路由和性能元数据：
{
"id": "chatcmpl-abc123",
"choices": [...],
"usage": {...},
"openmodex": {
"request_id": "req_abc123",
"model_used": "gpt-4o-2024-08-06",
"provider": "openai",
"cache_hit": false,
"routing_strategy": "cost_optimized",
"fallback_used": false,
"latency_ms": 1250
}
}
POST 请求，您可以传递 Idempotency-Key 头以确保相同请求不会被重复处理：
curl https://api.openmodex.com/v1/chat/completions \
-H "Authorization: Bearer omx_sk_..." \
-H "Idempotency-Key: my-unique-key-123" \
-H "Content-Type: application/json" \
-d '...'