Merge pull request #4 from TanLuong/feature/custom-headers-266912103052723498

feat: support custom Extra Headers for API models

README.md

@@ -387,6 +387,43 @@ PicoClaw supports 30+ LLM providers through the `model_list` configuration. Use
 
 > \* AWS Bedrock requires build tag: `go build -tags bedrock`. Set `api_base` to a region name (e.g., `us-east-1`) for automatic endpoint resolution across all AWS partitions (aws, aws-cn, aws-us-gov). When using a full endpoint URL instead, you must also configure `AWS_REGION` via environment variable or AWS config/profile.
 
+<details>
+<summary><b>Custom Headers (Web UI & config.json)</b></summary>
+
+You can pass custom HTTP headers to your model API calls (useful for custom gateways, proxies, or specific provider features).
+
+**In the Web UI:**
+1. Go to the **Models** page and click **Add Model** or edit an existing one.
+2. Open the **Advanced** section.
+3. In the **Extra Headers** field, enter your custom headers in valid JSON format, for example:
+   ```json
+   {
+     "X-My-Header": "value",
+     "Authorization": "Bearer my-custom-token"
+   }
+   ```
+4. Save the model.
+
+**Directly in `config.json`:**
+Add the `extra_headers` field to your model configuration:
+```json
+{
+  "model_list": [
+    {
+      "model_name": "custom-header-model",
+      "model": "openai/gpt-4o",
+      "api_base": "https://api.myproxy.com/v1",
+      "api_key": "sk-123",
+      "extra_headers": {
+        "X-My-Header": "value"
+      }
+    }
+  ]
+}
+```
+
+</details>
+
 <details>
 <summary><b>Local deployment (Ollama, vLLM, etc.)</b></summary>
 

pkg/config/config.go

@@ -856,6 +856,7 @@ type ModelConfig struct {
 	RequestTimeout int            `json:"request_timeout,omitempty"`
 	ThinkingLevel  string            `json:"thinking_level,omitempty"` // Extended thinking: off|low|medium|high|xhigh|adaptive
 	ExtraBody      map[string]any    `json:"extra_body,omitempty"`     // Additional fields to inject into request body
+	ExtraHeaders   map[string]string `json:"extra_headers,omitempty"`  // Additional headers to inject into request
 
 	// from security
 	secModelName string
@@ -2068,6 +2069,7 @@ func expandMultiKeyModels(models []*ModelConfig) []*ModelConfig {
 			RequestTimeout: m.RequestTimeout,
 			ThinkingLevel:  m.ThinkingLevel,
 			ExtraBody:      m.ExtraBody,
+			ExtraHeaders:   m.ExtraHeaders,
 			apiKeys:        []string{keys[0]},
 		}
 

pkg/providers/factory_provider.go

@@ -99,6 +99,7 @@ func CreateProviderFromConfig(cfg *config.ModelConfig) (LLMProvider, string, err
 			cfg.MaxTokensField,
 			cfg.RequestTimeout,
 			cfg.ExtraBody,
+			cfg.ExtraHeaders,
 		), modelID, nil
 
 	case "azure", "azure-openai":
@@ -193,6 +194,7 @@ func CreateProviderFromConfig(cfg *config.ModelConfig) (LLMProvider, string, err
 			cfg.MaxTokensField,
 			cfg.RequestTimeout,
 			cfg.ExtraBody,
+			cfg.ExtraHeaders,
 		), modelID, nil
 
 	case "minimax":
@@ -218,6 +220,7 @@ func CreateProviderFromConfig(cfg *config.ModelConfig) (LLMProvider, string, err
 			cfg.MaxTokensField,
 			cfg.RequestTimeout,
 			extraBody,
+			cfg.ExtraHeaders,
 		), modelID, nil
 
 	case "anthropic":
@@ -244,6 +247,7 @@ func CreateProviderFromConfig(cfg *config.ModelConfig) (LLMProvider, string, err
 			cfg.MaxTokensField,
 			cfg.RequestTimeout,
 			cfg.ExtraBody,
+			cfg.ExtraHeaders,
 		), modelID, nil
 
 	case "anthropic-messages":

pkg/providers/http_provider.go

@@ -24,13 +24,14 @@ func NewHTTPProvider(apiKey, apiBase, proxy string) *HTTPProvider {
 }
 
 func NewHTTPProviderWithMaxTokensField(apiKey, apiBase, proxy, maxTokensField string) *HTTPProvider {
-	return NewHTTPProviderWithMaxTokensFieldAndRequestTimeout(apiKey, apiBase, proxy, maxTokensField, 0, nil)
+	return NewHTTPProviderWithMaxTokensFieldAndRequestTimeout(apiKey, apiBase, proxy, maxTokensField, 0, nil, nil)
 }
 
 func NewHTTPProviderWithMaxTokensFieldAndRequestTimeout(
 	apiKey, apiBase, proxy, maxTokensField string,
 	requestTimeoutSeconds int,
 	extraBody map[string]any,
+	extraHeaders map[string]string,
 ) *HTTPProvider {
 	return &HTTPProvider{
 		delegate: openai_compat.NewProvider(
@@ -40,6 +41,7 @@ func NewHTTPProviderWithMaxTokensFieldAndRequestTimeout(
 			openai_compat.WithMaxTokensField(maxTokensField),
 			openai_compat.WithRequestTimeout(time.Duration(requestTimeoutSeconds)*time.Second),
 			openai_compat.WithExtraBody(extraBody),
+			openai_compat.WithExtraHeaders(extraHeaders),
 		),
 	}
 }

pkg/providers/openai_compat/provider.go

@@ -36,6 +36,7 @@ type Provider struct {
 	maxTokensField string // Field name for max tokens (e.g., "max_completion_tokens" for o1/glm models)
 	httpClient     *http.Client
 	extraBody      map[string]any    // Additional fields to inject into request body
+	extraHeaders   map[string]string // Additional headers to inject into request
 }
 
 type Option func(*Provider)
@@ -62,6 +63,12 @@ func WithExtraBody(extraBody map[string]any) Option {
 	}
 }
 
+func WithExtraHeaders(extraHeaders map[string]string) Option {
+	return func(p *Provider) {
+		p.extraHeaders = extraHeaders
+	}
+}
+
 func NewProvider(apiKey, apiBase, proxy string, opts ...Option) *Provider {
 	p := &Provider{
 		apiKey:     apiKey,
@@ -183,6 +190,9 @@ func (p *Provider) Chat(
 	if p.apiKey != "" {
 		req.Header.Set("Authorization", "Bearer "+p.apiKey)
 	}
+	for k, v := range p.extraHeaders {
+		req.Header.Set(k, v)
+	}
 
 	resp, err := p.httpClient.Do(req)
 	if err != nil {
@@ -229,6 +239,9 @@ func (p *Provider) ChatStream(
 	if p.apiKey != "" {
 		req.Header.Set("Authorization", "Bearer "+p.apiKey)
 	}
+	for k, v := range p.extraHeaders {
+		req.Header.Set(k, v)
+	}
 
 	// Use a client without Timeout for streaming — the http.Client.Timeout covers
 	// the entire request lifecycle including body reads, which would kill long streams.

web/backend/api/models.go

@@ -39,6 +39,7 @@ type modelResponse struct {
 	RequestTimeout int            `json:"request_timeout,omitempty"`
 	ThinkingLevel  string            `json:"thinking_level,omitempty"`
 	ExtraBody      map[string]any    `json:"extra_body,omitempty"`
+	ExtraHeaders   map[string]string `json:"extra_headers,omitempty"`
 	// Meta
 	Configured bool `json:"configured"`
 	IsDefault  bool `json:"is_default"`
@@ -85,6 +86,7 @@ func (h *Handler) handleListModels(w http.ResponseWriter, r *http.Request) {
 			RequestTimeout: m.RequestTimeout,
 			ThinkingLevel:  m.ThinkingLevel,
 			ExtraBody:      m.ExtraBody,
+			ExtraHeaders:   m.ExtraHeaders,
 			Configured:     configured[i],
 			IsDefault:      m.ModelName == defaultModel,
 			IsVirtual:      m.IsVirtual(),
@@ -212,6 +214,9 @@ func (h *Handler) handleUpdateModel(w http.ResponseWriter, r *http.Request) {
 	} else if len(mc.ExtraBody) == 0 {
 		mc.ExtraBody = nil
 	}
+	if mc.ExtraHeaders == nil {
+		mc.ExtraHeaders = cfg.ModelList[idx].ExtraHeaders
+	}
 
 	cfg.ModelList[idx] = &mc.ModelConfig
 

web/frontend/src/api/models.ts

@@ -18,6 +18,7 @@ export interface ModelInfo {
   request_timeout?: number
   thinking_level?: string
   extra_body?: Record<string, unknown>
+  extra_headers?: Record<string, string>
   // Meta
   configured: boolean
   is_default: boolean

web/frontend/src/components/models/add-model-sheet.tsx

@@ -35,6 +35,7 @@ interface AddForm {
   maxTokensField: string
   requestTimeout: string
   thinkingLevel: string
+  extraHeaders: string
   extraBody: string
 }
 
@@ -51,6 +52,7 @@ const EMPTY_ADD_FORM: AddForm = {
   maxTokensField: "",
   requestTimeout: "",
   thinkingLevel: "",
+  extraHeaders: "",
   extraBody: "",
 }
 
@@ -98,6 +100,16 @@ export function AddModelSheet({
       errors.modelName = t("models.add.errorDuplicateModelName")
     }
     if (!form.model.trim()) errors.model = t("models.add.errorRequired")
+    if (form.extraHeaders.trim()) {
+      try {
+        const parsed = JSON.parse(form.extraHeaders.trim())
+        if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
+          errors.extraHeaders = "Must be a valid JSON object"
+        }
+      } catch {
+        errors.extraHeaders = "Invalid JSON format"
+      }
+    }
     setFieldErrors(errors)
     return Object.keys(errors).length === 0
   }
@@ -132,6 +144,7 @@ export function AddModelSheet({
           ? Number(form.requestTimeout)
           : undefined,
         thinking_level: form.thinkingLevel.trim() || undefined,
+        extra_headers: form.extraHeaders.trim() ? JSON.parse(form.extraHeaders.trim()) : undefined,
         extra_body: form.extraBody.trim()
           ? JSON.parse(form.extraBody.trim())
           : undefined,
@@ -313,6 +326,18 @@ export function AddModelSheet({
               </Field>
 
               <Field
+                label={t("models.field.extraHeaders")}
+                hint={t("models.field.extraHeadersHint")}
+              >
+                <Input
+                  value={form.extraHeaders}
+                  onChange={setField("extraHeaders")}
+                  placeholder='{"X-My-Header": "value"}'
+                  aria-invalid={!!fieldErrors.extraHeaders}
+                />
+                {fieldErrors.extraHeaders && (
+                  <p className="text-destructive text-xs">{fieldErrors.extraHeaders}</p>
+                )}
                 label={t("models.field.extraBody")}
                 hint={t("models.field.extraBodyHint")}
               >

web/frontend/src/components/models/edit-model-sheet.tsx

@@ -33,6 +33,7 @@ interface EditForm {
   maxTokensField: string
   requestTimeout: string
   thinkingLevel: string
+  extraHeaders: string
   extraBody: string
 }
 
@@ -61,6 +62,7 @@ export function EditModelSheet({
     maxTokensField: "",
     requestTimeout: "",
     thinkingLevel: "",
+    extraHeaders: "",
     extraBody: "",
   })
   const [saving, setSaving] = useState(false)
@@ -82,6 +84,7 @@ export function EditModelSheet({
           ? String(model.request_timeout)
           : "",
         thinkingLevel: model.thinking_level ?? "",
+        extraHeaders: model.extra_headers ? JSON.stringify(model.extra_headers) : "",
         extraBody: model.extra_body
           ? JSON.stringify(model.extra_body, null, 2)
           : "",
@@ -97,6 +100,18 @@ export function EditModelSheet({
 
   const handleSave = async () => {
     if (!model) return
+    if (form.extraHeaders.trim()) {
+      try {
+        const parsed = JSON.parse(form.extraHeaders.trim())
+        if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
+          setError("Extra headers must be a valid JSON object")
+          return
+        }
+      } catch {
+        setError("Extra headers must be valid JSON format")
+        return
+      }
+    }
     setSaving(true)
     setError("")
     try {
@@ -115,6 +130,7 @@ export function EditModelSheet({
           ? Number(form.requestTimeout)
           : undefined,
         thinking_level: form.thinkingLevel || undefined,
+        extra_headers: form.extraHeaders.trim() ? JSON.parse(form.extraHeaders.trim()) : undefined,
         extra_body: form.extraBody.trim()
           ? JSON.parse(form.extraBody.trim())
           : {},
@@ -284,6 +300,13 @@ export function EditModelSheet({
               </Field>
 
               <Field
+                label={t("models.field.extraHeaders")}
+                hint={t("models.field.extraHeadersHint")}
+              >
+                <Input
+                  value={form.extraHeaders}
+                  onChange={setField("extraHeaders")}
+                  placeholder='{"X-My-Header": "value"}'
                 label={t("models.field.extraBody")}
                 hint={t("models.field.extraBodyHint")}
               >

web/frontend/src/i18n/locales/en.json

@@ -210,6 +210,8 @@
       "thinkingLevelHint": "Extended thinking budget: off, low, medium, high, xhigh, adaptive.",
       "maxTokensField": "Max Tokens Field",
       "maxTokensFieldHint": "Override the request field name for max tokens, e.g. max_completion_tokens.",
+      "extraHeaders": "Extra Headers",
+      "extraHeadersHint": "Custom HTTP headers in JSON format, e.g. {\"X-My-Header\": \"value\"}"
       "extraBody": "Extra Body",
       "extraBodyHint": "Additional JSON fields to inject into the request body, e.g. {\"reasoning_split\": true}."
     },