Skip to content

Clarify where the LLM API key files should be. #9758 #9760

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

Merged
akshay-joshi merged 1 commit into from
Mar 17, 2026
+14 −4
Merged

Clarify where the LLM API key files should be. #9758 #9760

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
4 changes: 2 additions & 2 deletions docs/en_US/ai_tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Select your preferred LLM provider from the dropdown:
Use Claude models from Anthropic, or any Anthropic-compatible API provider.

* **API URL**: Custom API endpoint URL (leave empty for default: https://api.anthropic.com/v1).
* **API Key File**: Path to a file containing your Anthropic API key (obtain from https://console.anthropic.com/). Optional when using a custom URL with a provider that does not require authentication.
* **API Key File**: Path to a file containing your Anthropic API key (obtain from https://console.anthropic.com/). This path refers to the filesystem where the pgAdmin server is running (e.g., inside the container if using Docker). The ``~`` prefix is expanded to the home directory of the user running the pgAdmin server process. Optional when using a custom URL with a provider that does not require authentication.
* **Model**: Select from available Claude models (e.g., claude-sonnet-4-20250514).

**OpenAI**
Use GPT models from OpenAI, or any OpenAI-compatible API provider (e.g.,
LiteLLM, LM Studio, EXO, or other local inference servers).

* **API URL**: Custom API endpoint URL (leave empty for default: https://api.openai.com/v1). Include the ``/v1`` path prefix if required by your provider.
* **API Key File**: Path to a file containing your OpenAI API key (obtain from https://platform.openai.com/). Optional when using a custom URL with a provider that does not require authentication.
* **API Key File**: Path to a file containing your OpenAI API key (obtain from https://platform.openai.com/). This path refers to the filesystem where the pgAdmin server is running (e.g., inside the container if using Docker). The ``~`` prefix is expanded to the home directory of the user running the pgAdmin server process. Optional when using a custom URL with a provider that does not require authentication.
* **Model**: Select from available GPT models (e.g., gpt-4).

**Ollama**
Expand Down
10 changes: 8 additions & 2 deletions docs/en_US/preferences.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,10 @@ Use the fields on the *AI* panel to configure your LLM provider:
to use an Anthropic-compatible API provider.

* Use the *API Key File* field to specify the path to a file containing your
Anthropic API key. The API key may be optional when using a custom API URL
Anthropic API key. This path refers to the filesystem where the pgAdmin
server is running (e.g., inside the container if using Docker). The ``~``
prefix is expanded to the home directory of the user running the pgAdmin
server process. The API key may be optional when using a custom API URL
with a provider that does not require authentication.

* Use the *Model* field to select from the available Claude models. Click the
Expand All @@ -68,7 +71,10 @@ Use the fields on the *AI* panel to configure your LLM provider:
(e.g., ``http://localhost:1234/v1``).

* Use the *API Key File* field to specify the path to a file containing your
OpenAI API key. The API key may be optional when using a custom API URL
OpenAI API key. This path refers to the filesystem where the pgAdmin
server is running (e.g., inside the container if using Docker). The ``~``
prefix is expanded to the home directory of the user running the pgAdmin
server process. The API key may be optional when using a custom API URL
with a provider that does not require authentication.

* Use the *Model* field to select from the available GPT models. Click the
Expand Down
4 changes: 4 additions & 0 deletions web/pgadmin/llm/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ def register_preferences(self):
category_label=gettext('Anthropic'),
help_str=gettext(
'Path to a file containing your Anthropic API key. '
'This path must be on the server hosting pgAdmin, '
'e.g. inside the container when using Docker. '
'The file should contain only the API key. The API key '
'may be optional when using a custom API URL with a '
'provider that does not require authentication.'
Expand Down Expand Up @@ -185,6 +187,8 @@ def register_preferences(self):
category_label=gettext('OpenAI'),
help_str=gettext(
'Path to a file containing your OpenAI API key. '
'This path must be on the server hosting pgAdmin, '
'e.g. inside the container when using Docker. '
'The file should contain only the API key. The API key '
'may be optional when using a custom API URL with a '
'provider that does not require authentication.'
Expand Down
Loading