用途
omni-providers 是 OmniRoute 提供的服务商连接管理模块,用于通过 REST API 统一管理 AI 服务商的接入配置。其核心目标是在 OmniRoute 的 327 个服务商目录中完成服务商集成与连接维护,包括 API Key、OAuth 流程和连接测试。
主要能力
- 服务商连接的增删改查:GET/POST /api/providers、GET/PATCH/DELETE /api/providers/{id}。
- 连接测试与批量测试:POST /api/providers/{id}/test、POST /api/providers/test-batch。
- 服务商节点管理:GET/POST /api/provider-nodes、PATCH/DELETE /api/provider-nodes/{id}、POST /api/provider-nodes/validate。
- 服务商模型管理:GET /api/provider-models、POST /api/provider-models/validate-and-add、POST /api/providers/{id}/sync-models。
- 令牌与连接维护:POST /api/providers/{id}/refresh(轮换/刷新 OAuth 令牌或重新校验凭证)、POST /api/providers/{id}/refresh-token、POST /api/providers/{id}/refresh-cursor。
- 观测与诊断:GET /api/provider-metrics(请求数、错误率、延迟分位、token 用量)、GET /api/providers/health-matrix(连接状态、熔断状态、冷却到期)、GET /api/providers/health-autopilot、GET /api/providers/quota-windows、GET /api/providers/expiration。
- 导入导出与迁移:POST /api/providers/import、批量操作 POST /api/providers/bulk、POST /api/providers/bulk-web-session。
- 服务商专属认证流程:Claude(claude-auth/import、import-bulk、zip-extract、apply-local)、Codex(codex-auth/import、import-bulk、zip-extract、apply-local、export)、AGY(agy-auth/import、import-bulk、zip-extract、apply-local)、Command Code(auth/start、auth/callback、auth/status、auth/apply)、Zed(discover、import、manual-import)、Volcengine Plan(connect、code、identity、resend、cancel、status)。
- 其他接口:聊天 Web 与 Codex 诊断(chatgpt-web-codex-doctor)、拦截规则(interception-rules)、参数过滤器(param-filters)、CC 别名(cc-alias)、免费引导(free-onboarding)、OpenRouter 统计(openrouter-stats)、客户端(client)、Cursor 代理可用性(cursor/agent-availability)。
使用方式
所有请求需有效的 Bearer Token 或会话 Cookie。可通过 POST /api/auth/login 获取令牌,或在本地开发环境中将 REQUIRE_API_KEY 设为 false。以下为文档中给出的示例:
刷新连接:
curl -X POST https://localhost:20128/api/providers/{id}/refresh \
-H "Authorization: Bearer $OMNIROUTE_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
获取指标:
curl https://localhost:20128/api/provider-metrics \
-H "Authorization: Bearer $OMNIROUTE_TOKEN"
指标响应示例:
{
"providers": [
{
"id": "my-openai",
"requestCount": 1240,
"errorRate": 0.02,
"p50LatencyMs": 340,
"p99LatencyMs": 1200,
"tokensIn": 500000,
"tokensOut": 250000
}
]
}
健康矩阵:
curl https://localhost:20128/api/providers/health-matrix \
-H "Authorization: Bearer $OMNIROUTE_TOKEN"
详细的请求/响应结构请参考 GET /api/openapi/spec 或 docs/openapi.yaml。
适用场景
- 在 OmniRoute 中批量接入、维护和排查多个 AI 服务商连接。
- 需要在令牌过期后不删除连接的情况下刷新凭据。
- 希望通过指标与健康矩阵排查路由决策、错误率或熔断/冷却状态。
- 需要为 Claude、Codex、Zed、Volcengine Plan 等服务商执行特定的认证导入或 OAuth 授权流程。
限制
- 所有接口均要求 Bearer Token 或会话 Cookie,未配置认证时将无法调用(本地开发可关闭 REQUIRE_API_KEY)。
- 资料未提供服务的收费、价格、配额上限或平台兼容性等信息,暂未提供。
- 各接口的具体请求体与响应字段需查阅 OpenAPI 规范,资料中未逐一列出。