Back to Details

omni-providers

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- generated by src/lib/agentSkills/generator.ts; manual edits will be overwritten -->
<!-- 由 src/lib/agentSkills/generator.ts 生成；手动编辑将被覆盖 -->

Overview

概述

Manage provider connections, API keys, OAuth flows, and connection tests via the REST API. List, add, update, remove, and test AI provider integrations across OmniRoute's 375-provider catalog.
通过 REST API 管理提供商连接、API 密钥、OAuth 流程和连接测试。列出、添加、更新、移除并测试 OmniRoute 375 个提供商目录中的 AI 提供商集成。

Authentication

身份验证

All requests require a valid Bearer token or session cookie. Obtain a token via 
POST /api/auth/login
or configure 
REQUIRE_API_KEY=false
for local development.
所有请求都需要有效的 Bearer 令牌或会话 Cookie。可通过 
POST /api/auth/login
获取令牌，或在本地开发环境中配置 
REQUIRE_API_KEY=false
。

Endpoints

端点

  • GET /api/providers
  • POST /api/providers
  • GET /api/providers/{id}
  • PATCH /api/providers/{id}
  • DELETE /api/providers/{id}
  • POST /api/providers/{id}/test
  • GET /api/providers/{id}/test-message
  • POST /api/providers/{id}/test-message
  • PUT /api/providers/{id}/test-message
  • GET /api/providers/{id}/models
  • GET /api/providers/cursor/agent-availability
  • POST /api/providers/test-batch
  • POST /api/providers/validate
  • GET /api/providers/client
  • POST /api/providers/agy-auth/import
  • POST /api/providers/agy-auth/import-bulk
  • POST /api/providers/agy-auth/zip-extract
  • POST /api/providers/agy-auth/apply-local
  • GET /api/provider-nodes
  • POST /api/provider-nodes
  • PATCH /api/provider-nodes/{id}
  • DELETE /api/provider-nodes/{id}
  • POST /api/provider-nodes/validate
  • GET /api/provider-models
  • PUT /api/provider-models
  • POST /api/provider-models/validate-and-add
  • GET /api/providers/{id}/cc-alias
  • PUT /api/providers/{id}/cc-alias
  • GET /api/providers/{id}/chatgpt-web-codex-doctor
  • POST /api/providers/{id}/claude-auth/apply-local
  • POST /api/providers/{id}/claude-auth/export
  • POST /api/providers/{id}/codex-auth/apply-local
  • POST /api/providers/{id}/codex-auth/export
  • GET /api/providers/{id}/interception-rules
  • PUT /api/providers/{id}/interception-rules
  • DELETE /api/providers/{id}/interception-rules
  • POST /api/providers/{id}/login
  • GET /api/providers/{id}/param-filters
  • PUT /api/providers/{id}/param-filters
  • DELETE /api/providers/{id}/param-filters
  • POST /api/providers/{id}/refresh
  • POST /api/providers/{id}/refresh-cursor
  • POST /api/providers/{id}/refresh-token
  • POST /api/providers/{id}/sync-models
  • POST /api/providers/bulk
  • POST /api/providers/bulk-web-session
  • POST /api/providers/claude-auth/import
  • POST /api/providers/claude-auth/import-bulk
  • POST /api/providers/claude-auth/zip-extract
  • POST /api/providers/codex-auth/import
  • POST /api/providers/codex-auth/import-bulk
  • POST /api/providers/codex-auth/zip-extract
  • POST /api/providers/command-code/auth/apply
  • POST /api/providers/command-code/auth/callback
  • POST /api/providers/command-code/auth/start
  • GET /api/providers/command-code/auth/status
  • POST /api/providers/command-code/auth/status
  • GET /api/providers/expiration
  • GET /api/providers/free-onboarding
  • POST /api/providers/free-onboarding
  • GET /api/providers/health-autopilot
  • POST /api/providers/health-autopilot/actions
  • GET /api/providers/health-matrix
  • POST /api/providers/import
  • GET /api/providers/openrouter-stats
  • GET /api/providers/quota-windows
  • POST /api/providers/volcengine-plan/connect
  • POST /api/providers/volcengine-plan/connect/{sessionId}/cancel
  • POST /api/providers/volcengine-plan/connect/{sessionId}/code
  • POST /api/providers/volcengine-plan/connect/{sessionId}/identity
  • POST /api/providers/volcengine-plan/connect/{sessionId}/resend
  • GET /api/providers/volcengine-plan/connect/{sessionId}/status
  • GET /api/providers/web-session-contract
  • POST /api/providers/zed/discover
  • POST /api/providers/zed/import
  • POST /api/providers/zed/manual-import
  • GET /api/providers
  • POST /api/providers
  • GET /api/providers/{id}
  • PATCH /api/providers/{id}
  • DELETE /api/providers/{id}
  • POST /api/providers/{id}/test
  • GET /api/providers/{id}/test-message
  • POST /api/providers/{id}/test-message
  • PUT /api/providers/{id}/test-message
  • GET /api/providers/{id}/models
  • GET /api/providers/cursor/agent-availability
  • POST /api/providers/test-batch
  • POST /api/providers/validate
  • GET /api/providers/client
  • POST /api/providers/agy-auth/import
  • POST /api/providers/agy-auth/import-bulk
  • POST /api/providers/agy-auth/zip-extract
  • POST /api/providers/agy-auth/apply-local
  • GET /api/provider-nodes
  • POST /api/provider-nodes
  • PATCH /api/provider-nodes/{id}
  • DELETE /api/provider-nodes/{id}
  • POST /api/provider-nodes/validate
  • GET /api/provider-models
  • PUT /api/provider-models
  • POST /api/provider-models/validate-and-add
  • GET /api/providers/{id}/cc-alias
  • PUT /api/providers/{id}/cc-alias
  • GET /api/providers/{id}/chatgpt-web-codex-doctor
  • POST /api/providers/{id}/claude-auth/apply-local
  • POST /api/providers/{id}/claude-auth/export
  • POST /api/providers/{id}/codex-auth/apply-local
  • POST /api/providers/{id}/codex-auth/export
  • GET /api/providers/{id}/interception-rules
  • PUT /api/providers/{id}/interception-rules
  • DELETE /api/providers/{id}/interception-rules
  • POST /api/providers/{id}/login
  • GET /api/providers/{id}/param-filters
  • PUT /api/providers/{id}/param-filters
  • DELETE /api/providers/{id}/param-filters
  • POST /api/providers/{id}/refresh
  • POST /api/providers/{id}/refresh-cursor
  • POST /api/providers/{id}/refresh-token
  • POST /api/providers/{id}/sync-models
  • POST /api/providers/bulk
  • POST /api/providers/bulk-web-session
  • POST /api/providers/claude-auth/import
  • POST /api/providers/claude-auth/import-bulk
  • POST /api/providers/claude-auth/zip-extract
  • POST /api/providers/codex-auth/import
  • POST /api/providers/codex-auth/import-bulk
  • POST /api/providers/codex-auth/zip-extract
  • POST /api/providers/command-code/auth/apply
  • POST /api/providers/command-code/auth/callback
  • POST /api/providers/command-code/auth/start
  • GET /api/providers/command-code/auth/status
  • POST /api/providers/command-code/auth/status
  • GET /api/providers/expiration
  • GET /api/providers/free-onboarding
  • POST /api/providers/free-onboarding
  • GET /api/providers/health-autopilot
  • POST /api/providers/health-autopilot/actions
  • GET /api/providers/health-matrix
  • POST /api/providers/import
  • GET /api/providers/openrouter-stats
  • GET /api/providers/quota-windows
  • POST /api/providers/volcengine-plan/connect
  • POST /api/providers/volcengine-plan/connect/{sessionId}/cancel
  • POST /api/providers/volcengine-plan/connect/{sessionId}/code
  • POST /api/providers/volcengine-plan/connect/{sessionId}/identity
  • POST /api/providers/volcengine-plan/connect/{sessionId}/resend
  • GET /api/providers/volcengine-plan/connect/{sessionId}/status
  • GET /api/providers/web-session-contract
  • POST /api/providers/zed/discover
  • POST /api/providers/zed/import
  • POST /api/providers/zed/manual-import

Payloads

请求载荷

See the full OpenAPI specification at 
GET /api/openapi/spec
or 
docs/openapi.yaml
for detailed request/response schemas.
<!-- skill:custom-start -->
有关详细的请求/响应架构，请参阅 
GET /api/openapi/spec
或 
docs/openapi.yaml
中的完整 OpenAPI 规范。
<!-- skill:custom-start -->

Additional endpoints

附加端点

POST /api/providers/{id}/refresh

POST /api/providers/{id}/refresh

Rotate / refresh OAuth tokens or re-validate credentials for a provider connection. Useful after token expiration or when credentials need to be renewed without deleting the connection.
bash
curl -X POST https://localhost:20128/api/providers/{id}/refresh \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
轮换或刷新 OAuth 令牌，或重新验证提供商连接的凭据。适用于令牌过期后，或需要在不删除连接的情况下续期凭据时。
bash
curl -X POST https://localhost:20128/api/providers/{id}/refresh \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET /api/provider-metrics

GET /api/provider-metrics

Retrieve aggregated usage and performance metrics for all provider connections (request counts, error rates, latency percentiles, token usage). Used by dashboards and Auto-Combo scoring.
bash
curl https://localhost:20128/api/provider-metrics \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
Response example:
json
{
  "providers": [
    {
      "id": "my-openai",
      "requestCount": 1240,
      "errorRate": 0.02,
      "p50LatencyMs": 340,
      "p99LatencyMs": 1200,
      "tokensIn": 500000,
      "tokensOut": 250000
    }
  ]
}
获取所有提供商连接的汇总使用量和性能指标（请求计数、错误率、延迟百分位数、令牌用量）。供仪表板和 Auto-Combo 评分使用。
bash
curl https://localhost:20128/api/provider-metrics \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
响应示例：
json
{
  "providers": [
    {
      "id": "my-openai",
      "requestCount": 1240,
      "errorRate": 0.02,
      "p50LatencyMs": 340,
      "p99LatencyMs": 1200,
      "tokensIn": 500000,
      "tokensOut": 250000
    }
  ]
}

GET /api/providers/health-matrix

GET /api/providers/health-matrix

Returns a health-matrix view of all providers with per-connection status, circuit-breaker state, and cooldown expiry. Useful for debugging routing decisions.
bash
curl https://localhost:20128/api/providers/health-matrix \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
<!-- skill:custom-end -->
返回所有提供商的健康矩阵视图，其中包含各连接状态、断路器状态和冷却期到期时间。适用于调试路由决策。
bash
curl https://localhost:20128/api/providers/health-matrix \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
<!-- skill:custom-end -->