|
| 1 | +--- |
| 2 | +description: "OrcaRouter inference provider for accessing aggregated frontier and open models via the OrcaRouter gateway." |
| 3 | +sidebar_label: Remote - Orcarouter |
| 4 | +title: remote::orcarouter |
| 5 | +--- |
| 6 | + |
| 7 | +# remote::orcarouter |
| 8 | + |
| 9 | +## Description |
| 10 | + |
| 11 | +OrcaRouter inference provider for accessing aggregated frontier and open models via the OrcaRouter gateway. |
| 12 | + |
| 13 | +## Configuration |
| 14 | + |
| 15 | +| Field | Type | Required | Default | Description | |
| 16 | +|-------|------|----------|---------|-------------| |
| 17 | +| `allowed_models` | `list[str] \| None` | No | | List of models that should be registered with the model registry. If None, all models are allowed. | |
| 18 | +| `refresh_models` | `bool` | No | False | Whether to refresh models periodically from the provider | |
| 19 | +| `api_key` | `SecretStr \| None` | No | | Authentication credential for the provider | |
| 20 | +| `network` | `NetworkConfig \| None` | No | | Network configuration including TLS, proxy, and timeout settings. | |
| 21 | +| `network.tls` | `TLSConfig \| None` | No | | TLS/SSL configuration for secure connections. | |
| 22 | +| `network.tls.verify` | `bool \| Path` | No | True | Whether to verify TLS certificates. Can be a boolean or a path to a CA certificate file. | |
| 23 | +| `network.tls.min_version` | `Literal[TLSv1.2, TLSv1.3] \| None` | No | | Minimum TLS version to use. Defaults to system default if not specified. | |
| 24 | +| `network.tls.ciphers` | `list[str] \| None` | No | | List of allowed cipher suites (e.g., ['ECDHE+AESGCM', 'DHE+AESGCM']). | |
| 25 | +| `network.tls.client_cert` | `Path \| None` | No | | Path to client certificate file for mTLS authentication. | |
| 26 | +| `network.tls.client_key` | `Path \| None` | No | | Path to client private key file for mTLS authentication. | |
| 27 | +| `network.proxy` | `ProxyConfig \| None` | No | | Proxy configuration for HTTP connections. | |
| 28 | +| `network.proxy.url` | `HttpUrl \| None` | No | | Single proxy URL for all connections (e.g., 'http://proxy.example.com:8080'). | |
| 29 | +| `network.proxy.http` | `HttpUrl \| None` | No | | Proxy URL for HTTP connections. | |
| 30 | +| `network.proxy.https` | `HttpUrl \| None` | No | | Proxy URL for HTTPS connections. | |
| 31 | +| `network.proxy.cacert` | `Path \| None` | No | | Path to CA certificate file for verifying the proxy's certificate. Required for proxies in interception mode. | |
| 32 | +| `network.proxy.no_proxy` | `list[str] \| None` | No | | List of hosts that should bypass the proxy (e.g., ['localhost', '127.0.0.1', '.internal.corp']). | |
| 33 | +| `network.timeout` | `float \| TimeoutConfig \| None` | No | | Timeout configuration. Can be a float (for both connect and read) or a TimeoutConfig object with separate connect and read timeouts. | |
| 34 | +| `network.timeout.connect` | `float \| None` | No | | Connection timeout in seconds. | |
| 35 | +| `network.timeout.read` | `float \| None` | No | | Read timeout in seconds. | |
| 36 | +| `network.headers` | `dict[str, str] \| None` | No | | Additional HTTP headers to include in all requests. | |
| 37 | +| `network.limits` | `LimitsConfig \| None` | No | | HTTP connection pool limits (max connections, keepalive connections, keepalive expiry). None uses httpx's own defaults. | |
| 38 | +| `network.limits.max_connections` | `int \| None` | No | 100 | Maximum number of concurrent connections in the pool. None means no limit. Values must be >= 1 if set. | |
| 39 | +| `network.limits.max_keepalive_connections` | `int \| None` | No | 20 | Maximum number of idle keep-alive connections to retain. None means no limit. Values must be >= 0 if set. | |
| 40 | +| `network.limits.keepalive_expiry` | `float \| None` | No | 5.0 | Time in seconds to keep idle keep-alive connections open before closing them. None means no expiry. Values must be >= 0 if set. | |
| 41 | +| `base_url` | `HttpUrl \| None` | No | https://api.orcarouter.ai/v1 | Base URL for the OrcaRouter API | |
| 42 | + |
| 43 | +## Sample Configuration |
| 44 | + |
| 45 | +```yaml |
| 46 | +base_url: https://api.orcarouter.ai/v1 |
| 47 | +api_key: ${env.ORCAROUTER_API_KEY:=} |
| 48 | +``` |
0 commit comments