From b693d632d2c9643561c5f6f3c12372454bab1ddd Mon Sep 17 00:00:00 2001 From: hkfires <10558748+hkfires@users.noreply.github.com> Date: Wed, 3 Dec 2025 12:31:41 +0800 Subject: [PATCH] docs(config): comment out example API key configurations --- config.example.yaml | 224 ++++++++++++++++++++++---------------------- 1 file changed, 112 insertions(+), 112 deletions(-) diff --git a/config.example.yaml b/config.example.yaml index c1636166..61f51d47 100644 --- a/config.example.yaml +++ b/config.example.yaml @@ -56,129 +56,129 @@ quota-exceeded: ws-auth: false # Gemini API keys -gemini-api-key: - - api-key: "AIzaSy...01" - base-url: "https://generativelanguage.googleapis.com" - headers: - X-Custom-Header: "custom-value" - proxy-url: "socks5://proxy.example.com:1080" - 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" +# gemini-api-key: +# - api-key: "AIzaSy...01" +# base-url: "https://generativelanguage.googleapis.com" +# headers: +# X-Custom-Header: "custom-value" +# proxy-url: "socks5://proxy.example.com:1080" +# 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" # Codex API keys -codex-api-key: - - api-key: "sk-atSM..." - base-url: "https://www.example.com" # use the custom codex API endpoint - headers: - X-Custom-Header: "custom-value" - proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override - 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) +# codex-api-key: +# - api-key: "sk-atSM..." +# base-url: "https://www.example.com" # use the custom codex API endpoint +# headers: +# X-Custom-Header: "custom-value" +# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override +# 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) # 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..." - 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 - models: - - name: "claude-3-5-sonnet-20241022" # upstream model name - alias: "claude-sonnet-latest" # client alias mapped to the upstream model - excluded-models: - - "claude-opus-4-5-20251101" # exclude specific models (exact match) - - "claude-3-*" # wildcard matching prefix (e.g. claude-3-7-sonnet-20250219) - - "*-think" # wildcard matching suffix (e.g. claude-opus-4-5-thinking) - - "*haiku*" # wildcard matching substring (e.g. claude-3-5-haiku-20241022) +# claude-api-key: +# - api-key: "sk-atSM..." # use the official claude API key, no need to set the base url +# - api-key: "sk-atSM..." +# 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 +# models: +# - name: "claude-3-5-sonnet-20241022" # upstream model name +# alias: "claude-sonnet-latest" # client alias mapped to the upstream model +# excluded-models: +# - "claude-opus-4-5-20251101" # exclude specific models (exact match) +# - "claude-3-*" # wildcard matching prefix (e.g. claude-3-7-sonnet-20250219) +# - "*-think" # wildcard matching suffix (e.g. claude-opus-4-5-thinking) +# - "*haiku*" # wildcard matching substring (e.g. claude-3-5-haiku-20241022) # OpenAI compatibility providers -openai-compatibility: - - name: "openrouter" # The name of the provider; it will be used in the user agent and other places. - base-url: "https://openrouter.ai/api/v1" # The base URL of the provider. - headers: - X-Custom-Header: "custom-value" - api-key-entries: - - api-key: "sk-or-v1-...b780" - proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override - - 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. +# openai-compatibility: +# - name: "openrouter" # The name of the provider; it will be used in the user agent and other places. +# base-url: "https://openrouter.ai/api/v1" # The base URL of the provider. +# headers: +# X-Custom-Header: "custom-value" +# api-key-entries: +# - api-key: "sk-or-v1-...b780" +# proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override +# - 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. # Vertex API keys (Vertex-compatible endpoints, use API key + base URL) -vertex-api-key: - - api-key: "vk-123..." # x-goog-api-key header - base-url: "https://example.com/api" # e.g. https://zenmux.ai/api - proxy-url: "socks5://proxy.example.com:1080" # optional per-key proxy override - headers: - X-Custom-Header: "custom-value" - models: # optional: map aliases to upstream model names - - name: "gemini-2.0-flash" # upstream model name - alias: "vertex-flash" # client-visible alias - - name: "gemini-1.5-pro" - alias: "vertex-pro" +# vertex-api-key: +# - api-key: "vk-123..." # x-goog-api-key header +# base-url: "https://example.com/api" # e.g. https://zenmux.ai/api +# proxy-url: "socks5://proxy.example.com:1080" # optional per-key proxy override +# headers: +# X-Custom-Header: "custom-value" +# models: # optional: map aliases to upstream model names +# - name: "gemini-2.0-flash" # upstream model name +# alias: "vertex-flash" # client-visible alias +# - name: "gemini-1.5-pro" +# alias: "vertex-pro" # Amp Integration -ampcode: - # Configure upstream URL for Amp CLI OAuth and management features - upstream-url: "https://ampcode.com" - # Optional: Override API key for Amp upstream (otherwise uses env or file) - upstream-api-key: "" - # Restrict Amp management routes (/api/auth, /api/user, etc.) to localhost only (recommended) - restrict-management-to-localhost: true - # Amp Model Mappings - # Route unavailable Amp models to alternative models available in your local proxy. - # Useful when Amp CLI requests models you don't have access to (e.g., Claude Opus 4.5) - # but you have a similar model available (e.g., Claude Sonnet 4). - model-mappings: - - from: "claude-opus-4.5" # Model requested by Amp CLI - to: "claude-sonnet-4" # Route to this available model instead - - from: "gpt-5" - to: "gemini-2.5-pro" - - from: "claude-3-opus-20240229" - to: "claude-3-5-sonnet-20241022" +# ampcode: +# # Configure upstream URL for Amp CLI OAuth and management features +# upstream-url: "https://ampcode.com" +# # Optional: Override API key for Amp upstream (otherwise uses env or file) +# upstream-api-key: "" +# # Restrict Amp management routes (/api/auth, /api/user, etc.) to localhost only (recommended) +# restrict-management-to-localhost: true +# # Amp Model Mappings +# # Route unavailable Amp models to alternative models available in your local proxy. +# # Useful when Amp CLI requests models you don't have access to (e.g., Claude Opus 4.5) +# # but you have a similar model available (e.g., Claude Sonnet 4). +# model-mappings: +# - from: "claude-opus-4.5" # Model requested by Amp CLI +# to: "claude-sonnet-4" # Route to this available model instead +# - from: "gpt-5" +# to: "gemini-2.5-pro" +# - from: "claude-3-opus-20240229" +# to: "claude-3-5-sonnet-20241022" # OAuth provider excluded models -oauth-excluded-models: - gemini-cli: - - "gemini-2.5-pro" # exclude specific models (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) - vertex: - - "gemini-3-pro-preview" - aistudio: - - "gemini-3-pro-preview" - antigravity: - - "gemini-3-pro-preview" - claude: - - "claude-3-5-haiku-20241022" - codex: - - "gpt-5-codex-mini" - qwen: - - "vision-model" - iflow: - - "tstars2.0" +# oauth-excluded-models: +# gemini-cli: +# - "gemini-2.5-pro" # exclude specific models (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) +# vertex: +# - "gemini-3-pro-preview" +# aistudio: +# - "gemini-3-pro-preview" +# antigravity: +# - "gemini-3-pro-preview" +# claude: +# - "claude-3-5-haiku-20241022" +# codex: +# - "gpt-5-codex-mini" +# qwen: +# - "vision-model" +# iflow: +# - "tstars2.0" # Optional payload configuration -payload: - default: # Default rules only set parameters when they are missing in the payload. - - models: - - name: "gemini-2.5-pro" # Supports wildcards (e.g., "gemini-*") - protocol: "gemini" # restricts the rule to a specific protocol, options: openai, gemini, claude, codex - params: # JSON path (gjson/sjson syntax) -> value - "generationConfig.thinkingConfig.thinkingBudget": 32768 - override: # Override rules always set parameters, overwriting any existing values. - - models: - - name: "gpt-*" # Supports wildcards (e.g., "gpt-*") - protocol: "codex" # restricts the rule to a specific protocol, options: openai, gemini, claude, codex - params: # JSON path (gjson/sjson syntax) -> value - "reasoning.effort": "high" +# payload: +# default: # Default rules only set parameters when they are missing in the payload. +# - models: +# - name: "gemini-2.5-pro" # Supports wildcards (e.g., "gemini-*") +# protocol: "gemini" # restricts the rule to a specific protocol, options: openai, gemini, claude, codex +# params: # JSON path (gjson/sjson syntax) -> value +# "generationConfig.thinkingConfig.thinkingBudget": 32768 +# override: # Override rules always set parameters, overwriting any existing values. +# - models: +# - name: "gpt-*" # Supports wildcards (e.g., "gpt-*") +# protocol: "codex" # restricts the rule to a specific protocol, options: openai, gemini, claude, codex +# params: # JSON path (gjson/sjson syntax) -> value +# "reasoning.effort": "high"