# Server host/interface to bind to. Default is empty ("") to bind all interfaces (IPv4 + IPv6).# Use "127.0.0.1" or "localhost" to restrict access to local machine only.host: "" # Server portport: 8317 # TLS settings for HTTPS. When enabled, the server listens with the provided certificate and key.tls: enable: false cert: "" key: "" # Management API settingsremote-management: # Whether to allow remote (non-localhost) management access. # When false, only localhost can access management endpoints (a key is still required). allow-remote: false # Management key. If a plaintext value is provided here, it will be hashed on startup. # All management requests (even from localhost) require this key. # Leave empty to disable the Management API entirely (404 for all /v0/management routes). secret-key: "" # Disable the bundled management control panel asset download and HTTP route when true. disable-control-panel: false # Disable automatic periodic background updates of the management panel from GitHub (default: false). # When enabled, the panel is only downloaded on first access if missing, and never auto-updated afterward. # disable-auto-update-panel: false # GitHub repository for the management control panel. Accepts a repository URL or releases API URL. panel-github-repository: "https://github.com/router-for-me/Cli-Proxy-API-Management-Center" # Authentication directory (supports ~ for home directory)auth-dir: "~/.cli-proxy-api" # API keys for authenticationapi-keys: - "your-api-key-1" - "your-api-key-2" - "your-api-key-3" # Enable debug loggingdebug: false # Enable pprof HTTP debug server (host:port). Keep it bound to localhost for safety.pprof: enable: false addr: "127.0.0.1:8316" # Credential concurrency is configured by Home in Home mode. The synthesized Home config is# authoritative and local values, including the values below, are ignored. Do not use local# configuration to override a Home concurrency policy.# credential-concurrency:# lifecycle-config-revision: 1# observation-barrier-revision: 0# cpa-heartbeat-timeout: "3s"# cpa-cancel-bound: "5s"# reclaim-grace: "5s"# cleanup-interval: "5s"# release-flush-interval: 250ms# release-max-backoff: 2s# busy-retry-min: 250ms# busy-retry-max: 1s# max-limit: 1000000 # Credential in-flight observation snapshot contract.# credential-in-flight:# snapshot-interval: 2s# stale-after: 10s# max-part-bytes: 262144# max-part-count: 64# max-revision-bytes: 16777216# max-aggregate-groups: 100000# max-details: 10000# max-string-bytes: 256# staging-retention: 1m # Standard dynamic library plugins are trusted in-process code. They are disabled by default.# Build Go examples with go build -buildmode=c-shared for the target GOOS/GOARCH.# Other languages can implement the same C ABI and JSON method protocol.# Plugin executors require a matching auth record with the same provider key.# If the same provider is configured as OpenAI-compatible, the native executor wins.# Plugin command-line flags and Management API routes are optional capabilities.# Existing native flags/routes and higher-priority plugin flags/routes cannot be replaced.# Plugin list Management API reads Logo and ConfigFields from plugin metadata for management UI display.# Per-plugin enabled only controls plugins.configs.<pluginID>.enabled and does not implicitly change global plugins.enabled.plugins: enabled: false dir: "plugins" # Additional plugin store registries. The built-in official registry is always included. # store-sources: # - "https://example.com/cliproxy-plugins/registry.json" # Optional plugin store auth rules. Values are read from environment variables; # tokens are not written into plugin manifests or node status. # store-auth: # - match: "https://example.com/cliproxy-plugins/" # apply-to: ["registry", "artifact"] # type: bearer # token-env: "CLIPROXY_PLUGIN_STORE_TOKEN" configs: example: enabled: true priority: 1 config1: true config2: "string" config3: 3 mode: "safe" # enum example: safe, fast # When true, disable high-overhead request logging and HTTP middleware features to reduce per-request memory usage under high concurrency.commercial-mode: false # When true, write application logs to rotating files instead of stdoutlogging-to-file: false # Maximum total size (MB) of log files under the logs directory. When exceeded, the oldest log# files are deleted until within the limit. Set to 0 to disable.logs-max-total-size-mb: 0 # Maximum number of error log files retained when request logging is disabled.# When exceeded, the oldest error log files are deleted. Default is 10. Set to 0 to disable cleanup.error-logs-max-files: 10 # When false, disable in-memory usage statistics aggregationusage-statistics-enabled: false # How long (in seconds) usage queue items are retained in memory for the Management API.# The local Redis RESP usage output is disabled.# Default: 60. Max: 3600.redis-usage-queue-retention-seconds: 60 # Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/# Per-entry proxy-url also supports "direct" or "none" to bypass both the global proxy-url and environment proxies explicitly.proxy-url: "" # When true, unprefixed model requests only use credentials without a prefix (except when prefix == model name).force-model-prefix: false # When true, forward filtered upstream response headers to downstream clients.# Default is false (disabled).passthrough-headers: false # Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504.request-retry: 3 # Maximum number of different credentials to try for one failed request.# Set to 0 to keep legacy behavior (try all available credentials).max-retry-credentials: 0 # Maximum wait time in seconds for a cooled-down credential before triggering a retry.max-retry-interval: 30 # When true, disable auth/model cooldown scheduling globally (prevents blackout windows after failure states).disable-cooling: false # When true, persist per-auth cooldown status as .cds files next to auth files.# Default is false; when false, cooldown status is kept in memory only.save-cooldown-status: false # Cooldown duration in seconds for transient upstream errors (408/500/502/503/504).# Set to 0 to keep the legacy 60-second cooldown; set to -1 to disable transient error cooldowns.transient-error-cooldown-seconds: 0 # When true, globally disable Claude request cloaking (the Claude Code CLI disguise and# system prompt replacement), so the original system prompt is passed through to Claude as-is.# Individual credentials can still override this: a claude-api-key entry via its "cloak.mode",# or a Claude OAuth/token file via a "cloak_mode" value. Default false keeps the per-client# "auto" behavior (cloak only non-Claude-Code clients).disable-claude-cloak-mode: false # Claude Code compatibility settings.claude-code: # When true, return original model IDs in Anthropic model list responses instead of cloaked IDs. disable-cloaking-model-list: false # disable-image-generation supports: false (default), true, "chat", or "passthrough".# - true: disable image_generation everywhere (also returns 404 for /v1/images/generations and /v1/images/edits).# - "chat": disable image_generation injection on non-images endpoints, but keep /v1/images/generations and /v1/images/edits enabled.# - "passthrough": never inject or strip image_generation on non-images endpoints (forward the client payload unchanged); behaves like "chat" on /v1/images/* endpoints.disable-image-generation: false # Base model used by the legacy hosted image_generation tool path when a Codex image request is not proxied directly through the Image API.# Must start with "gpt-" (case-insensitive). If unset or invalid, defaults to "gpt-5.4-mini".# gpt-image-2-base-model: "gpt-5.4-mini" # How long video IDs returned by /openai/v1/videos and xAI video creation stay bound# to the credential that created them. Default: 3h.video-result-auth-cache-ttl: "3h" # Core auth auto-refresh worker pool size (OAuth/file-based auth token refresh).# When > 0, overrides the default worker count (16).# auth-auto-refresh-workers: 16 # Quota exceeded behaviorquota-exceeded: switch-project: true # Whether to automatically switch to another project when a quota is exceeded switch-preview-model: true # Whether to automatically switch to a preview model when a quota is exceeded antigravity-credits: true # Whether to use credits as last-resort fallback when all free-tier auths are exhausted for Claude models # Routing strategy for selecting credentials when multiple match.routing: strategy: "round-robin" # round-robin (default), weighted-round-robin, fill-first # weighted-round-robin uses each credential's integer weight (default 1, maximum 1,000,000). # Non-positive weights exclude the credential while this strategy is active. # For OAuth/file credentials, add a top-level numeric "weight" field to the auth JSON. # Enable universal session-sticky routing for all clients. # Explicit Claude Code, Codex, OpenCode, and pi session headers are preferred, # followed by prompt_cache_key, Responses conversation IDs, legacy body IDs, # execution or derived session identity, and the existing first-message hash fallback. # Automatic failover is always enabled when bound auth becomes unavailable. session-affinity: false # default: false # How long session-to-auth bindings are retained. Default: 1h session-affinity-ttl: "1h" # Codex provider behavior.codex: # When true, and routing.strategy is fill-first or routing.session-affinity is true, # remap Codex prompt_cache_key and installation identity per selected auth. # Some superstitious users believe request tracking identifiers can be used # as evidence for TOS enforcement bans; this option only satisfies those odd concerns. identity-confuse: false # Disable forcing the official Codex User-Agent and Originator headers on HTTP/SSE and WebSocket requests. disable-codex-cloaking: false # When true, optimize Codex Desktop and codex-tui requests for multi-agent v2. # This refreshes Codex spawn_agent model details, removes message parameter encryption, # normalizes encrypted agent_message content for Codex, and converts agent_message input # into standard user messages for non-Codex upstream protocols. optimize-multi-agent-v2: false # Terminate and relay Codex Live WebRTC audio and DataChannel traffic in this process. # This requires inbound UDP reachability. Keep disabled to preserve direct media behavior. live-media-relay: enabled: false # Maximum concurrent media sessions. Zero uses the default of 32. max-sessions: 32 # Reject downstream SDP candidates that target private, loopback, link-local, or unspecified IPs. # Keep false for local or trusted-network Codex Desktop connections. disable-private-remote-ips: false # Public IPv4 or IPv6 address advertised when CPA is behind 1:1 NAT. public-ip: "" # Optional UDP allocation range. Both values must be set together and provide at least two ports per session. udp-port-min: 0 udp-port-max: 0 # Optional STUN/TURN servers. TURN credentials are never returned by the JSON config API. # Without a concrete global/per-auth proxy-url, WebRTC uses normal direct ICE/STUN/TURN connectivity. # With http, https, socks5, or socks5h proxy-url, the OpenAI-facing leg is forced through # authenticated ICE-TCP over that proxy and never falls back to UDP or a direct connection. # The Codex Desktop-facing leg remains direct, and configured ICE servers still apply to it. # ice-servers: # - urls: # - "stun:stun.example.com:3478" # - urls: # - "turn:turn.example.com:3478?transport=udp" # username: "user" # credential: "secret" # xAI provider behavior.xai: # When true, inject the native x_search tool when the request does not declare it. # The injected tool is also added to tool_choice.allowed_tools when applicable. inject-x-search: false # When true, enable authentication for the WebSocket API (/v1/ws).ws-auth: true # When > 0, emit blank lines every N seconds for non-streaming responses to prevent idle timeouts.nonstream-keepalive-interval: 0# Streaming behavior (SSE keep-alives + safe bootstrap retries).# streaming:# keepalive-seconds: 15 # Default: 0 (disabled). <= 0 disables keep-alives.# bootstrap-retries: 1 # Default: 0 (disabled). Retries before first byte is sent. # Signature cache validation for thinking blocks (Antigravity/Claude).# When true (default), cached signatures are preferred and validated.# When false, client signatures are used directly after normalization (bypass mode for testing).# antigravity-signature-cache-enabled: true # Bypass mode signature validation strictness (only applies when signature cache is disabled).# When true, validates full Claude protobuf tree (Field 2 -> Field 1 structure).# When false (default), only checks R/E prefix + base64 + first byte 0x12.# antigravity-signature-bypass-strict: false # Gemini API keys# gemini-api-key:# - api-key: "AIzaSy...01"# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# prefix: "test" # optional: require calls like "test/gemini-3-pro-preview" to target this credential# disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling# base-url: "https://generativelanguage.googleapis.com"# headers:# X-Custom-Header: "custom-value"# proxy-url: "socks5://proxy.example.com:1080"# # proxy-url: "direct" # optional: explicit direct connect for this credential# models:# - name: "gemini-2.5-flash" # upstream model name# alias: "gemini-flash" # client alias mapped to the upstream model# display-name: "Gemini Flash" # optional catalog display name# thinking: # optional: exact thinking capability for this configured model# levels: ["high", "medium", "low", "none", "auto"]# excluded-models:# - "gemini-2.5-pro" # exclude specific models from this provider (exact match)# - "gemini-2.5-*" # wildcard matching prefix (e.g. gemini-2.5-flash, gemini-2.5-pro)# - "*-preview" # wildcard matching suffix (e.g. gemini-3-pro-preview)# - "*flash*" # wildcard matching substring (e.g. gemini-2.5-flash-lite)# - api-key: "AIzaSy...02" # Native Interactions API keys# These keys are used only for direct /v1beta/interactions execution. Regular gemini-api-key entries still# send Gemini generateContent/streamGenerateContent requests when the client enters through the interactions API.# interactions-api-key:# - api-key: "AIzaSy...03"# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# prefix: "native" # optional: require calls like "native/gemini-3-pro-preview" to target this credential# disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling# base-url: "https://generativelanguage.googleapis.com"# headers:# X-Custom-Header: "custom-value"# proxy-url: "socks5://proxy.example.com:1080"# # proxy-url: "direct" # optional: explicit direct connect for this credential# models:# - name: "gemini-2.5-flash" # upstream model name# alias: "native-gemini-flash" # client alias mapped to the upstream model# thinking: # optional: exact thinking capability for this configured model# levels: ["high", "medium", "low", "none", "auto"]# excluded-models:# - "gemini-2.5-pro" # Codex API keys# codex-api-key:# - api-key: "sk-atSM..."# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# prefix: "test" # optional: require calls like "test/gpt-5-codex" to target this credential# disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling# base-url: "https://www.example.com" # use the custom codex API endpoint# alpha-search: false # optional: allow this key to serve /v1/alpha/search via base-url + /alpha/search# headers:# X-Custom-Header: "custom-value"# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override# # proxy-url: "direct" # optional: explicit direct connect for this credential# models:# - name: "gpt-5-codex" # upstream model name# alias: "codex-latest" # client alias mapped to the upstream model# display-name: "Codex Latest" # optional catalog display name# force-mapping: true # optional: rewrite response model fields back to the alias# thinking: # optional: exact thinking capability for this configured model# levels: ["xhigh", "high", "medium", "low"]# excluded-models:# - "gpt-5.1" # exclude specific models (exact match)# - "gpt-5-*" # wildcard matching prefix (e.g. gpt-5-medium, gpt-5-codex)# - "*-mini" # wildcard matching suffix (e.g. gpt-5-codex-mini)# - "*codex*" # wildcard matching substring (e.g. gpt-5-codex-low) # xAI API keys# Uses the native xAI executor, including its Responses namespace-tool handling.# xai-api-key:# - api-key: "xai-..."# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# prefix: "xai" # optional: require calls like "xai/grok-4.5" to target this credential# disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling# base-url: "https://api.x.ai/v1" # xAI-compatible Responses API endpoint# websockets: true # optional: use the xAI upstream websocket transport for downstream websocket requests# headers:# X-Custom-Header: "custom-value"# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override# # proxy-url: "direct" # optional: explicit direct connect for this credential# models:# - name: "grok-4.5" # upstream model name# alias: "grok-latest" # client alias mapped to the upstream model# display-name: "Grok Latest" # optional catalog display name# force-mapping: true # optional: rewrite response model fields back to the alias# thinking: # optional: exact thinking capability for this configured model# levels: ["xhigh", "high", "medium", "low"]# excluded-models:# - "grok-4.1" # exclude specific models (exact match)# - "grok-3-*" # wildcard matching prefix # Claude API keys# claude-api-key:# - api-key: "sk-atSM..." # use the official claude API key, no need to set the base url# - api-key: "sk-atSM..."# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# prefix: "test" # optional: require calls like "test/claude-sonnet-latest" to target this credential# disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling# base-url: "https://www.example.com" # use the custom claude API endpoint# headers:# X-Custom-Header: "custom-value"# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override# # proxy-url: "direct" # optional: explicit direct connect for this credential# models:# - name: "claude-3-5-sonnet-20241022" # upstream model name# alias: "claude-sonnet-latest" # client alias mapped to the upstream model# display-name: "Claude Sonnet" # optional catalog display name# force-mapping: true # optional: rewrite response model fields back to the alias# thinking: # optional: exact thinking capability for this configured model# levels: ["max", "xhigh", "high", "medium", "low", "minimal", "none", "auto"]# excluded-models:# - "claude-opus-4-5-20251101" # exclude specific models (exact match)# - "claude-3-*" # wildcard matching prefix (e.g. claude-3-7-sonnet-20250219)# - "*-thinking" # wildcard matching suffix (e.g. claude-opus-4-5-thinking)# - "*haiku*" # wildcard matching substring (e.g. claude-3-5-haiku-20241022)# rebuild-mid-system-message: false # optional: default is false; when true, move messages with role "system" into the top-level Claude system field# cloak: # optional: request cloaking for non-Claude-Code clients# mode: "auto" # "auto" (default): cloak only when client is not Claude Code# # "always": always apply cloaking# # "never": never apply cloaking# # This "cloak" block applies to this claude-api-key entry only. For Claude OAuth# # credentials, set the same options in the auth/token JSON file via "cloak_mode" /# # "cloak_strict_mode" / "cloak_sensitive_words" / "cloak_cache_user_id". The top-level# # "disable-claude-cloak-mode: true" disables cloaking for all Claude credentials at once.# strict-mode: false # false (default): prepend Claude Code prompt to user system messages# # true: strip all user system messages, keep only Claude Code prompt# sensitive-words: # optional: words to obfuscate with zero-width characters# - "API"# - "proxy"# cache-user-id: true # optional: default is false; set true to reuse cached user_id per API key instead of generating a random one each request# experimental-cch-signing: false # optional: default is false; when true, sign the final /v1/messages body using the current Claude Code cch algorithm# # keep this disabled unless you explicitly need the behavior, so upstream seed changes fall back to legacy proxy behavior # Default headers for Claude API requests. Update when Claude Code releases new versions.# In legacy mode, user-agent/package-version/runtime-version/timeout are used as fallbacks# when the client omits them, while OS/arch remain runtime-derived. When# stabilize-device-profile is enabled, OS/arch stay pinned to the baseline values below,# while user-agent/package-version/runtime-version seed a software fingerprint that can# still upgrade to newer official Claude client versions.# claude-header-defaults:# user-agent: "claude-cli/2.1.44 (external, sdk-cli)"# package-version: "0.74.0"# runtime-version: "v24.3.0"# os: "MacOS"# arch: "arm64"# timeout: "600"# stabilize-device-profile: false # optional, default false; set true to enable per-auth/API-key fingerprint pinning # Default headers for Codex OAuth model requests.# These are used only for file-backed/OAuth Codex requests when the client# does not send the header. `user-agent` applies to HTTP and websocket requests;# `beta-features` only applies to websocket requests. They do not apply to codex-api-key entries.# codex-header-defaults:# user-agent: "codex_cli_rs/0.114.0 (Mac OS 14.2.0; x86_64) vscode/1.111.0"# beta-features: "multi_agent" # OpenAI compatibility providers# openai-compatibility:# - name: "openrouter" # The name of the provider; it will be used in the user agent and other places.# disabled: false # optional: set to true to disable this provider without removing it# prefix: "test" # optional: require calls like "test/kimi-k2" to target this provider's credentials# base-url: "https://openrouter.ai/api/v1" # The base URL of the provider.# support-prompt-cache-key: false # optional: derive prompt_cache_key for requests from all input protocols# disable-cooling: false # optional: per-provider override for auth/model cooldown scheduling# headers:# X-Custom-Header: "custom-value"# api-key-entries:# - api-key: "sk-or-v1-...b780"# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override# # proxy-url: "direct" # optional: explicit direct connect for this credential# - api-key: "sk-or-v1-...b781" # without proxy-url# models: # The models supported by the provider.# - name: "moonshotai/kimi-k2:free" # The actual model name.# alias: "kimi-k2" # The alias used in the API.# display-name: "Kimi K2" # optional catalog display name# image: false # optional: set true to allow this model on /v1/images/generations and /v1/images/edits (not chat/responses image input)# input-modalities: [text, image] # optional: declare /v1/chat/completions and /v1/responses multimodal input for Codex clients# output-modalities: [text] # optional: declare output modalities when known# thinking: # optional: omit to default to levels ["low","medium","high"]# levels: ["low", "medium", "high"]# # You may repeat the same alias to build an internal model pool.# # The client still sees only one alias in the model list.# # Requests to that alias will round-robin across the upstream names below,# # and if the chosen upstream fails before producing output, the request will# # continue with the next upstream model in the same alias pool.# - name: "deepseek-v3.1"# alias: "claude-opus-4.66"# - name: "glm-5"# alias: "claude-opus-4.66"# - name: "kimi-k2.5"# alias: "claude-opus-4.66" # Vertex API keys (Vertex-compatible endpoints, base-url is optional)# vertex-api-key:# - api-key: "vk-123..." # x-goog-api-key header# weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000# prefix: "test" # optional: require calls like "test/vertex-pro" to target this credential# base-url: "https://example.com/api" # optional, e.g. https://zenmux.ai/api; falls back to Google Vertex when omitted# proxy-url: "socks5://proxy.example.com:1080" # optional per-key proxy override# # proxy-url: "direct" # optional: explicit direct connect for this credential# headers:# X-Custom-Header: "custom-value"# models: # optional: map aliases to upstream model names# - name: "gemini-2.5-flash" # upstream model name# alias: "vertex-flash" # client-visible alias# display-name: "Vertex Flash" # optional catalog display name# thinking: # optional: exact thinking capability for this configured model# levels: ["high", "medium", "low", "none", "auto"]# - name: "gemini-2.5-pro"# alias: "vertex-pro"# excluded-models: # optional: models to exclude from listing# - "imagen-3.0-generate-002"# - "imagen-*" Lines 1–500 of 620. Load more
# Server host/interface to bind to. Default is empty ("") to bind all interfaces (IPv4 + IPv6). # Use "127.0.0.1" or "localhost" to restrict access to local machine only. host: "" # Server port port: 8317 # TLS settings for HTTPS. When enabled, the server listens with the provided certificate and key. tls: enable: false cert: "" key: "" # Management API settings remote-management: # Whether to allow remote (non-localhost) management access. # When false, only localhost can access management endpoints (a key is still required). allow-remote: false # Management key. If a plaintext value is provided here, it will be hashed on startup. # All management requests (even from localhost) require this key. # Leave empty to disable the Management API entirely (404 for all /v0/management routes). secret-key: "" # Disable the bundled management control panel asset download and HTTP route when true. disable-control-panel: false # Disable automatic periodic background updates of the management panel from GitHub (default: false). # When enabled, the panel is only downloaded on first access if missing, and never auto-updated afterward. # disable-auto-update-panel: false # GitHub repository for the management control panel. Accepts a repository URL or releases API URL. panel-github-repository: "https://github.com/router-for-me/Cli-Proxy-API-Management-Center" # Authentication directory (supports ~ for home directory) auth-dir: "~/.cli-proxy-api" # API keys for authentication api-keys: - "your-api-key-1" - "your-api-key-2" - "your-api-key-3" # Enable debug logging debug: false # Enable pprof HTTP debug server (host:port). Keep it bound to localhost for safety. pprof: enable: false addr: "127.0.0.1:8316" # Credential concurrency is configured by Home in Home mode. The synthesized Home config is # authoritative and local values, including the values below, are ignored. Do not use local # configuration to override a Home concurrency policy. # credential-concurrency: # lifecycle-config-revision: 1 # observation-barrier-revision: 0 # cpa-heartbeat-timeout: "3s" # cpa-cancel-bound: "5s" # reclaim-grace: "5s" # cleanup-interval: "5s" # release-flush-interval: 250ms # release-max-backoff: 2s # busy-retry-min: 250ms # busy-retry-max: 1s # max-limit: 1000000 # Credential in-flight observation snapshot contract. # credential-in-flight: # snapshot-interval: 2s # stale-after: 10s # max-part-bytes: 262144 # max-part-count: 64 # max-revision-bytes: 16777216 # max-aggregate-groups: 100000 # max-details: 10000 # max-string-bytes: 256 # staging-retention: 1m # Standard dynamic library plugins are trusted in-process code. They are disabled by default. # Build Go examples with go build -buildmode=c-shared for the target GOOS/GOARCH. # Other languages can implement the same C ABI and JSON method protocol. # Plugin executors require a matching auth record with the same provider key. # If the same provider is configured as OpenAI-compatible, the native executor wins. # Plugin command-line flags and Management API routes are optional capabilities. # Existing native flags/routes and higher-priority plugin flags/routes cannot be replaced. # Plugin list Management API reads Logo and ConfigFields from plugin metadata for management UI display. # Per-plugin enabled only controls plugins.configs.<pluginID>.enabled and does not implicitly change global plugins.enabled. plugins: enabled: false dir: "plugins" # Additional plugin store registries. The built-in official registry is always included. # store-sources: # - "https://example.com/cliproxy-plugins/registry.json" # Optional plugin store auth rules. Values are read from environment variables; # tokens are not written into plugin manifests or node status. # store-auth: # - match: "https://example.com/cliproxy-plugins/" # apply-to: ["registry", "artifact"] # type: bearer # token-env: "CLIPROXY_PLUGIN_STORE_TOKEN" configs: example: enabled: true priority: 1 config1: true config2: "string" config3: 3 mode: "safe" # enum example: safe, fast # When true, disable high-overhead request logging and HTTP middleware features to reduce per-request memory usage under high concurrency. commercial-mode: false # When true, write application logs to rotating files instead of stdout logging-to-file: false # Maximum total size (MB) of log files under the logs directory. When exceeded, the oldest log # files are deleted until within the limit. Set to 0 to disable. logs-max-total-size-mb: 0 # Maximum number of error log files retained when request logging is disabled. # When exceeded, the oldest error log files are deleted. Default is 10. Set to 0 to disable cleanup. error-logs-max-files: 10 # When false, disable in-memory usage statistics aggregation usage-statistics-enabled: false # How long (in seconds) usage queue items are retained in memory for the Management API. # The local Redis RESP usage output is disabled. # Default: 60. Max: 3600. redis-usage-queue-retention-seconds: 60 # Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/ # Per-entry proxy-url also supports "direct" or "none" to bypass both the global proxy-url and environment proxies explicitly. proxy-url: "" # When true, unprefixed model requests only use credentials without a prefix (except when prefix == model name). force-model-prefix: false # When true, forward filtered upstream response headers to downstream clients. # Default is false (disabled). passthrough-headers: false # Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504. request-retry: 3 # Maximum number of different credentials to try for one failed request. # Set to 0 to keep legacy behavior (try all available credentials). max-retry-credentials: 0 # Maximum wait time in seconds for a cooled-down credential before triggering a retry. max-retry-interval: 30 # When true, disable auth/model cooldown scheduling globally (prevents blackout windows after failure states). disable-cooling: false # When true, persist per-auth cooldown status as .cds files next to auth files. # Default is false; when false, cooldown status is kept in memory only. save-cooldown-status: false # Cooldown duration in seconds for transient upstream errors (408/500/502/503/504). # Set to 0 to keep the legacy 60-second cooldown; set to -1 to disable transient error cooldowns. transient-error-cooldown-seconds: 0 # When true, globally disable Claude request cloaking (the Claude Code CLI disguise and # system prompt replacement), so the original system prompt is passed through to Claude as-is. # Individual credentials can still override this: a claude-api-key entry via its "cloak.mode", # or a Claude OAuth/token file via a "cloak_mode" value. Default false keeps the per-client # "auto" behavior (cloak only non-Claude-Code clients). disable-claude-cloak-mode: false # Claude Code compatibility settings. claude-code: # When true, return original model IDs in Anthropic model list responses instead of cloaked IDs. disable-cloaking-model-list: false # disable-image-generation supports: false (default), true, "chat", or "passthrough". # - true: disable image_generation everywhere (also returns 404 for /v1/images/generations and /v1/images/edits). # - "chat": disable image_generation injection on non-images endpoints, but keep /v1/images/generations and /v1/images/edits enabled. # - "passthrough": never inject or strip image_generation on non-images endpoints (forward the client payload unchanged); behaves like "chat" on /v1/images/* endpoints. disable-image-generation: false # Base model used by the legacy hosted image_generation tool path when a Codex image request is not proxied directly through the Image API. # Must start with "gpt-" (case-insensitive). If unset or invalid, defaults to "gpt-5.4-mini". # gpt-image-2-base-model: "gpt-5.4-mini" # How long video IDs returned by /openai/v1/videos and xAI video creation stay bound # to the credential that created them. Default: 3h. video-result-auth-cache-ttl: "3h" # Core auth auto-refresh worker pool size (OAuth/file-based auth token refresh). # When > 0, overrides the default worker count (16). # auth-auto-refresh-workers: 16 # Quota exceeded behavior quota-exceeded: switch-project: true # Whether to automatically switch to another project when a quota is exceeded switch-preview-model: true # Whether to automatically switch to a preview model when a quota is exceeded antigravity-credits: true # Whether to use credits as last-resort fallback when all free-tier auths are exhausted for Claude models # Routing strategy for selecting credentials when multiple match. routing: strategy: "round-robin" # round-robin (default), weighted-round-robin, fill-first # weighted-round-robin uses each credential's integer weight (default 1, maximum 1,000,000). # Non-positive weights exclude the credential while this strategy is active. # For OAuth/file credentials, add a top-level numeric "weight" field to the auth JSON. # Enable universal session-sticky routing for all clients. # Explicit Claude Code, Codex, OpenCode, and pi session headers are preferred, # followed by prompt_cache_key, Responses conversation IDs, legacy body IDs, # execution or derived session identity, and the existing first-message hash fallback. # Automatic failover is always enabled when bound auth becomes unavailable. session-affinity: false # default: false # How long session-to-auth bindings are retained. Default: 1h session-affinity-ttl: "1h" # Codex provider behavior. codex: # When true, and routing.strategy is fill-first or routing.session-affinity is true, # remap Codex prompt_cache_key and installation identity per selected auth. # Some superstitious users believe request tracking identifiers can be used # as evidence for TOS enforcement bans; this option only satisfies those odd concerns. identity-confuse: false # Disable forcing the official Codex User-Agent and Originator headers on HTTP/SSE and WebSocket requests. disable-codex-cloaking: false # When true, optimize Codex Desktop and codex-tui requests for multi-agent v2. # This refreshes Codex spawn_agent model details, removes message parameter encryption, # normalizes encrypted agent_message content for Codex, and converts agent_message input # into standard user messages for non-Codex upstream protocols. optimize-multi-agent-v2: false # Terminate and relay Codex Live WebRTC audio and DataChannel traffic in this process. # This requires inbound UDP reachability. Keep disabled to preserve direct media behavior. live-media-relay: enabled: false # Maximum concurrent media sessions. Zero uses the default of 32. max-sessions: 32 # Reject downstream SDP candidates that target private, loopback, link-local, or unspecified IPs. # Keep false for local or trusted-network Codex Desktop connections. disable-private-remote-ips: false # Public IPv4 or IPv6 address advertised when CPA is behind 1:1 NAT. public-ip: "" # Optional UDP allocation range. Both values must be set together and provide at least two ports per session. udp-port-min: 0 udp-port-max: 0 # Optional STUN/TURN servers. TURN credentials are never returned by the JSON config API. # Without a concrete global/per-auth proxy-url, WebRTC uses normal direct ICE/STUN/TURN connectivity. # With http, https, socks5, or socks5h proxy-url, the OpenAI-facing leg is forced through # authenticated ICE-TCP over that proxy and never falls back to UDP or a direct connection. # The Codex Desktop-facing leg remains direct, and configured ICE servers still apply to it. # ice-servers: # - urls: # - "stun:stun.example.com:3478" # - urls: # - "turn:turn.example.com:3478?transport=udp" # username: "user" # credential: "secret" # xAI provider behavior. xai: # When true, inject the native x_search tool when the request does not declare it. # The injected tool is also added to tool_choice.allowed_tools when applicable. inject-x-search: false # When true, enable authentication for the WebSocket API (/v1/ws). ws-auth: true # When > 0, emit blank lines every N seconds for non-streaming responses to prevent idle timeouts. nonstream-keepalive-interval: 0 # Streaming behavior (SSE keep-alives + safe bootstrap retries). # streaming: # keepalive-seconds: 15 # Default: 0 (disabled). <= 0 disables keep-alives. # bootstrap-retries: 1 # Default: 0 (disabled). Retries before first byte is sent. # Signature cache validation for thinking blocks (Antigravity/Claude). # When true (default), cached signatures are preferred and validated. # When false, client signatures are used directly after normalization (bypass mode for testing). # antigravity-signature-cache-enabled: true # Bypass mode signature validation strictness (only applies when signature cache is disabled). # When true, validates full Claude protobuf tree (Field 2 -> Field 1 structure). # When false (default), only checks R/E prefix + base64 + first byte 0x12. # antigravity-signature-bypass-strict: false # Gemini API keys # gemini-api-key: # - api-key: "AIzaSy...01" # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # prefix: "test" # optional: require calls like "test/gemini-3-pro-preview" to target this credential # disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling # base-url: "https://generativelanguage.googleapis.com" # headers: # X-Custom-Header: "custom-value" # proxy-url: "socks5://proxy.example.com:1080" # # proxy-url: "direct" # optional: explicit direct connect for this credential # models: # - name: "gemini-2.5-flash" # upstream model name # alias: "gemini-flash" # client alias mapped to the upstream model # display-name: "Gemini Flash" # optional catalog display name # thinking: # optional: exact thinking capability for this configured model # levels: ["high", "medium", "low", "none", "auto"] # excluded-models: # - "gemini-2.5-pro" # exclude specific models from this provider (exact match) # - "gemini-2.5-*" # wildcard matching prefix (e.g. gemini-2.5-flash, gemini-2.5-pro) # - "*-preview" # wildcard matching suffix (e.g. gemini-3-pro-preview) # - "*flash*" # wildcard matching substring (e.g. gemini-2.5-flash-lite) # - api-key: "AIzaSy...02" # Native Interactions API keys # These keys are used only for direct /v1beta/interactions execution. Regular gemini-api-key entries still # send Gemini generateContent/streamGenerateContent requests when the client enters through the interactions API. # interactions-api-key: # - api-key: "AIzaSy...03" # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # prefix: "native" # optional: require calls like "native/gemini-3-pro-preview" to target this credential # disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling # base-url: "https://generativelanguage.googleapis.com" # headers: # X-Custom-Header: "custom-value" # proxy-url: "socks5://proxy.example.com:1080" # # proxy-url: "direct" # optional: explicit direct connect for this credential # models: # - name: "gemini-2.5-flash" # upstream model name # alias: "native-gemini-flash" # client alias mapped to the upstream model # thinking: # optional: exact thinking capability for this configured model # levels: ["high", "medium", "low", "none", "auto"] # excluded-models: # - "gemini-2.5-pro" # Codex API keys # codex-api-key: # - api-key: "sk-atSM..." # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # prefix: "test" # optional: require calls like "test/gpt-5-codex" to target this credential # disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling # base-url: "https://www.example.com" # use the custom codex API endpoint # alpha-search: false # optional: allow this key to serve /v1/alpha/search via base-url + /alpha/search # headers: # X-Custom-Header: "custom-value" # proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override # # proxy-url: "direct" # optional: explicit direct connect for this credential # models: # - name: "gpt-5-codex" # upstream model name # alias: "codex-latest" # client alias mapped to the upstream model # display-name: "Codex Latest" # optional catalog display name # force-mapping: true # optional: rewrite response model fields back to the alias # thinking: # optional: exact thinking capability for this configured model # levels: ["xhigh", "high", "medium", "low"] # excluded-models: # - "gpt-5.1" # exclude specific models (exact match) # - "gpt-5-*" # wildcard matching prefix (e.g. gpt-5-medium, gpt-5-codex) # - "*-mini" # wildcard matching suffix (e.g. gpt-5-codex-mini) # - "*codex*" # wildcard matching substring (e.g. gpt-5-codex-low) # xAI API keys # Uses the native xAI executor, including its Responses namespace-tool handling. # xai-api-key: # - api-key: "xai-..." # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # prefix: "xai" # optional: require calls like "xai/grok-4.5" to target this credential # disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling # base-url: "https://api.x.ai/v1" # xAI-compatible Responses API endpoint # websockets: true # optional: use the xAI upstream websocket transport for downstream websocket requests # headers: # X-Custom-Header: "custom-value" # proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override # # proxy-url: "direct" # optional: explicit direct connect for this credential # models: # - name: "grok-4.5" # upstream model name # alias: "grok-latest" # client alias mapped to the upstream model # display-name: "Grok Latest" # optional catalog display name # force-mapping: true # optional: rewrite response model fields back to the alias # thinking: # optional: exact thinking capability for this configured model # levels: ["xhigh", "high", "medium", "low"] # excluded-models: # - "grok-4.1" # exclude specific models (exact match) # - "grok-3-*" # wildcard matching prefix # Claude API keys # claude-api-key: # - api-key: "sk-atSM..." # use the official claude API key, no need to set the base url # - api-key: "sk-atSM..." # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # prefix: "test" # optional: require calls like "test/claude-sonnet-latest" to target this credential # disable-cooling: false # optional: per-auth override for auth/model cooldown scheduling # base-url: "https://www.example.com" # use the custom claude API endpoint # headers: # X-Custom-Header: "custom-value" # proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override # # proxy-url: "direct" # optional: explicit direct connect for this credential # models: # - name: "claude-3-5-sonnet-20241022" # upstream model name # alias: "claude-sonnet-latest" # client alias mapped to the upstream model # display-name: "Claude Sonnet" # optional catalog display name # force-mapping: true # optional: rewrite response model fields back to the alias # thinking: # optional: exact thinking capability for this configured model # levels: ["max", "xhigh", "high", "medium", "low", "minimal", "none", "auto"] # excluded-models: # - "claude-opus-4-5-20251101" # exclude specific models (exact match) # - "claude-3-*" # wildcard matching prefix (e.g. claude-3-7-sonnet-20250219) # - "*-thinking" # wildcard matching suffix (e.g. claude-opus-4-5-thinking) # - "*haiku*" # wildcard matching substring (e.g. claude-3-5-haiku-20241022) # rebuild-mid-system-message: false # optional: default is false; when true, move messages with role "system" into the top-level Claude system field # cloak: # optional: request cloaking for non-Claude-Code clients # mode: "auto" # "auto" (default): cloak only when client is not Claude Code # # "always": always apply cloaking # # "never": never apply cloaking # # This "cloak" block applies to this claude-api-key entry only. For Claude OAuth # # credentials, set the same options in the auth/token JSON file via "cloak_mode" / # # "cloak_strict_mode" / "cloak_sensitive_words" / "cloak_cache_user_id". The top-level # # "disable-claude-cloak-mode: true" disables cloaking for all Claude credentials at once. # strict-mode: false # false (default): prepend Claude Code prompt to user system messages # # true: strip all user system messages, keep only Claude Code prompt # sensitive-words: # optional: words to obfuscate with zero-width characters # - "API" # - "proxy" # cache-user-id: true # optional: default is false; set true to reuse cached user_id per API key instead of generating a random one each request # experimental-cch-signing: false # optional: default is false; when true, sign the final /v1/messages body using the current Claude Code cch algorithm # # keep this disabled unless you explicitly need the behavior, so upstream seed changes fall back to legacy proxy behavior # Default headers for Claude API requests. Update when Claude Code releases new versions. # In legacy mode, user-agent/package-version/runtime-version/timeout are used as fallbacks # when the client omits them, while OS/arch remain runtime-derived. When # stabilize-device-profile is enabled, OS/arch stay pinned to the baseline values below, # while user-agent/package-version/runtime-version seed a software fingerprint that can # still upgrade to newer official Claude client versions. # claude-header-defaults: # user-agent: "claude-cli/2.1.44 (external, sdk-cli)" # package-version: "0.74.0" # runtime-version: "v24.3.0" # os: "MacOS" # arch: "arm64" # timeout: "600" # stabilize-device-profile: false # optional, default false; set true to enable per-auth/API-key fingerprint pinning # Default headers for Codex OAuth model requests. # These are used only for file-backed/OAuth Codex requests when the client # does not send the header. `user-agent` applies to HTTP and websocket requests; # `beta-features` only applies to websocket requests. They do not apply to codex-api-key entries. # codex-header-defaults: # user-agent: "codex_cli_rs/0.114.0 (Mac OS 14.2.0; x86_64) vscode/1.111.0" # beta-features: "multi_agent" # OpenAI compatibility providers # openai-compatibility: # - name: "openrouter" # The name of the provider; it will be used in the user agent and other places. # disabled: false # optional: set to true to disable this provider without removing it # prefix: "test" # optional: require calls like "test/kimi-k2" to target this provider's credentials # base-url: "https://openrouter.ai/api/v1" # The base URL of the provider. # support-prompt-cache-key: false # optional: derive prompt_cache_key for requests from all input protocols # disable-cooling: false # optional: per-provider override for auth/model cooldown scheduling # headers: # X-Custom-Header: "custom-value" # api-key-entries: # - api-key: "sk-or-v1-...b780" # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override # # proxy-url: "direct" # optional: explicit direct connect for this credential # - api-key: "sk-or-v1-...b781" # without proxy-url # models: # The models supported by the provider. # - name: "moonshotai/kimi-k2:free" # The actual model name. # alias: "kimi-k2" # The alias used in the API. # display-name: "Kimi K2" # optional catalog display name # image: false # optional: set true to allow this model on /v1/images/generations and /v1/images/edits (not chat/responses image input) # input-modalities: [text, image] # optional: declare /v1/chat/completions and /v1/responses multimodal input for Codex clients # output-modalities: [text] # optional: declare output modalities when known # thinking: # optional: omit to default to levels ["low","medium","high"] # levels: ["low", "medium", "high"] # # You may repeat the same alias to build an internal model pool. # # The client still sees only one alias in the model list. # # Requests to that alias will round-robin across the upstream names below, # # and if the chosen upstream fails before producing output, the request will # # continue with the next upstream model in the same alias pool. # - name: "deepseek-v3.1" # alias: "claude-opus-4.66" # - name: "glm-5" # alias: "claude-opus-4.66" # - name: "kimi-k2.5" # alias: "claude-opus-4.66" # Vertex API keys (Vertex-compatible endpoints, base-url is optional) # vertex-api-key: # - api-key: "vk-123..." # x-goog-api-key header # weight: 5 # optional: weighted-round-robin share; omitted defaults to 1; maximum 1,000,000 # prefix: "test" # optional: require calls like "test/vertex-pro" to target this credential # base-url: "https://example.com/api" # optional, e.g. https://zenmux.ai/api; falls back to Google Vertex when omitted # proxy-url: "socks5://proxy.example.com:1080" # optional per-key proxy override # # proxy-url: "direct" # optional: explicit direct connect for this credential # headers: # X-Custom-Header: "custom-value" # models: # optional: map aliases to upstream model names # - name: "gemini-2.5-flash" # upstream model name # alias: "vertex-flash" # client-visible alias # display-name: "Vertex Flash" # optional catalog display name # thinking: # optional: exact thinking capability for this configured model # levels: ["high", "medium", "low", "none", "auto"] # - name: "gemini-2.5-pro" # alias: "vertex-pro" # excluded-models: # optional: models to exclude from listing # - "imagen-3.0-generate-002" # - "imagen-*"