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.

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.

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

Payloads

See the full OpenAPI specification at GET /api/openapi/spec or docs/openapi.yaml for detailed request/response schemas.

Additional endpoints

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.

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

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.

curl https://localhost:20128/api/provider-metrics \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

Response example:

{
  "providers": [
    {
      "id": "my-openai",
      "requestCount": 1240,
      "errorRate": 0.02,
      "p50LatencyMs": 340,
      "p99LatencyMs": 1200,
      "tokensIn": 500000,
      "tokensOut": 250000
    }
  ]
}

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.

curl https://localhost:20128/api/providers/health-matrix \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"