From fb84ee270bc87eb84249e60055acd0792aec0379 Mon Sep 17 00:00:00 2001 From: dianed-square <73617011+dianed-square@users.noreply.github.com> Date: Thu, 5 Feb 2026 14:38:52 -0800 Subject: [PATCH] docs: extended custom provider headers support (#7012) --- documentation/docs/getting-started/providers.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/documentation/docs/getting-started/providers.md b/documentation/docs/getting-started/providers.md index ff2a4e7776..1abb2f6f8c 100644 --- a/documentation/docs/getting-started/providers.md +++ b/documentation/docs/getting-started/providers.md @@ -329,7 +329,7 @@ For enterprise deployments, you can pre-configure these values using environment ## Configure Custom Provider -Custom providers let you connect to services that aren't in the [available providers](#available-providers) list. They appear in goose's provider list and can be selected like any other provider. +Create custom providers to connect to services that aren't [already supported](#available-providers) or customize how you connect to them. Custom providers appear in goose's provider list and can be selected like any other provider. **Benefits:** - **Multiple endpoints**: Switch between different services (e.g., vLLM, corporate proxy, OpenAI) @@ -338,7 +338,7 @@ Custom providers let you connect to services that aren't in the [available provi - **Custom naming**: Show "Corporate API" instead of "OpenAI" in the UI - **Separate credentials**: Assign each provider its own API key -Custom providers must use OpenAI, Anthropic, or Ollama compatible API formats. OpenAI-compatible providers can include custom headers for additional authentication, API keys, tokens, or tenant identifiers. Each custom provider maps to a JSON configuration file. +Custom providers must use OpenAI, Anthropic, or Ollama compatible API formats. They can include custom headers for additional authentication, API keys, tokens, or tenant identifiers. Each custom provider maps to a JSON configuration file. **To add a custom provider:** @@ -362,7 +362,7 @@ Custom providers must use OpenAI, Anthropic, or Ollama compatible API formats. O 7. Click `Create Provider` :::info Custom Headers - Currently, custom headers for OpenAI compatible providers can't be defined in goose Desktop. As a workaround, configure the provider using goose CLI or edit the provider configuration file directly. + Currently, custom headers can't be defined in goose Desktop. As a workaround, edit the provider configuration file after creation. ::: @@ -417,7 +417,11 @@ Custom providers must use OpenAI, Anthropic, or Ollama compatible API formats. O - For `Ollama Compatible` providers, press `Enter` to skip (or enter any value to be able to use the provider in goose Desktop) - **Available Models**: Comma-separated list of available model names - **Streaming Support**: Whether the API supports streaming responses - - **Custom Headers**: Required header names and values (`OpenAI Compatible` providers only) + - **Custom Headers**: Any additional header names and values + + :::info Custom Headers + Currently, custom headers can only be defined for OpenAI compatible providers in the CLI. For Anthropic or Ollama compatible providers, edit the provider configuration file after creation. + ::: @@ -476,7 +480,6 @@ Custom providers must use OpenAI, Anthropic, or Ollama compatible API formats. O 4. Click `Configure providers` 5. Click on your custom provider in the list 6. Update the fields you want to change -
**Important:** Verify that `Provider Type` shows the correct value before saving. Otherwise, it may default to `OpenAI Compatible` regardless of the original setting. 7. Click `Update Provider`