Skip to content

docs: document model provider headers #961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adilhafeez wants to merge 1 commit into from
Closed

docs: document model provider headers #961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/source/resources/configuration_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ The following is a complete reference of the ``plano_config.yml`` that controls
the Plano gateway. This where you enable capabilities like routing to upstream LLm providers, defining prompt_targets
where prompts get routed to, apply guardrails, and enable critical agent observability features.

``model_providers`` entries support an optional ``headers`` map for extra string HTTP headers sent to the
upstream provider. The deprecated ``llm_providers`` key accepts the same provider fields for legacy configs.

.. literalinclude:: includes/plano_config_full_reference.yaml
:language: yaml
:linenos:
Expand Down
5 changes: 5 additions & 0 deletions docs/source/resources/includes/plano_config_full_reference.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,15 @@ model_providers:
passthrough_auth: true

# Custom/self-hosted endpoint with explicit http_host override
# headers: optional key-value map of extra HTTP headers sent to the upstream
# provider. Legacy llm_providers entries support the same provider fields.
- model: openai/llama-3.3-70b
base_url: https://api.custom-provider.com
http_host: api.custom-provider.com
access_key: $CUSTOM_API_KEY
headers:
User-Agent: "Plano/1.0"
X-Organization-Id: "org-example"

# Model aliases - use friendly names instead of full provider model names
model_aliases:
Expand Down
6 changes: 6 additions & 0 deletions docs/source/resources/includes/plano_config_full_reference_rendered.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ listeners:
base_url: https://api.custom-provider.com
cluster_name: openai_api.custom-provider.com
endpoint: api.custom-provider.com
headers:
User-Agent: Plano/1.0
X-Organization-Id: org-example
http_host: api.custom-provider.com
model: llama-3.3-70b
name: openai/llama-3.3-70b
Expand Down Expand Up @@ -138,6 +141,9 @@ model_providers:
base_url: https://api.custom-provider.com
cluster_name: openai_api.custom-provider.com
endpoint: api.custom-provider.com
headers:
User-Agent: Plano/1.0
X-Organization-Id: org-example
http_host: api.custom-provider.com
model: llama-3.3-70b
name: openai/llama-3.3-70b
Expand Down
Loading