Skip to content

Commit 3b80b90

Browse files
dannykoppingdavid-fraley
authored andcommitted
chore: document key scopes for OpenAI and Anthropic for aibridge (#20903)
Closes coder/internal#1135 --------- Signed-off-by: Danny Kopping <danny@coder.com>
1 parent 46ea50e commit 3b80b90

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

docs/ai-coder/ai-bridge/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![AI bridge diagram](../../images/aibridge/aibridge_diagram.png)
44

5-
AI Bridge is a smart proxy for AI. It acts as a man-in-the-middle between your users' coding agents / IDEs
5+
AI Bridge is a smart gateway for AI. It acts as an intermediary between your users' coding agents / IDEs
66
and providers like OpenAI and Anthropic. By intercepting all the AI traffic between these clients and
77
the upstream APIs, AI Bridge can record user prompts, token usage, and tool invocations.
88

docs/ai-coder/ai-bridge/setup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ Set the following when routing [OpenAI-compatible](https://coder.com/docs/refere
3333

3434
The default base URL (`https://api.openai.com/v1/`) works for the native OpenAI service. Point the base URL at your preferred OpenAI-compatible endpoint (for example, a hosted proxy or LiteLLM deployment) when needed.
3535

36+
If you'd like to create an [OpenAI key](https://platform.openai.com/api-keys) with minimal privileges, this is the minimum required set:
37+
38+
![List Models scope should be set to "Read", Model Capabilities set to "Request"](../../images/aibridge/openai_key_scope.png)
39+
3640
### Anthropic
3741

3842
Set the following when routing [Anthropic-compatible](https://coder.com/docs/reference/cli/server#--aibridge-anthropic-key) traffic through AI Bridge:
@@ -42,6 +46,8 @@ Set the following when routing [Anthropic-compatible](https://coder.com/docs/ref
4246

4347
The default base URL (`https://api.anthropic.com/`) targets Anthropic's public API. Override it for Anthropic-compatible brokers.
4448

49+
Anthropic does not allow [API keys](https://console.anthropic.com/settings/keys) to have restricted permissions at the time of writing (Nov 2025).
50+
4551
### Amazon Bedrock
4652

4753
Set the following when routing [Amazon Bedrock](https://coder.com/docs/reference/cli/server#--aibridge-bedrock-region) traffic through AI Bridge:
29.3 KB
Loading

0 commit comments

Comments
 (0)