docs: add client configuration section and examples to AI Bridge #20340
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/ai-coder/ai-bridge.md
Outdated
|
|
||
| Configure your AI client to point to your Coder deployment's Bridge endpoints: | ||
|
|
||
| - **OpenAI-compatible clients**: Set `OPENAI_BASE_URL` to `https://coder.example.com/api/v2/api/experimental/aibridge/openai/v1/` |
Member
There was a problem hiding this comment.
Sometimes it's just .../aibridge/openai and not .../aibrdige/openai/v1
Contributor
There was a problem hiding this comment.
Indeed; it depends on the client 😞
docs/ai-coder/ai-bridge.md
Outdated
|
|
||
| ### Authentication | ||
|
|
||
| Instead of using provider-specific API keys (OpenAI/Anthropic keys), clients authenticate using your **Coder session token** or **API key**: |
Member
There was a problem hiding this comment.
Suggested change
| Instead of using provider-specific API keys (OpenAI/Anthropic keys), clients authenticate using your **Coder session token** or **API key**: | |
| Instead of using provider-specific API keys (OpenAI/Anthropic keys), clients authenticate using their **Coder session token** or **API key**: |
docs/ai-coder/ai-bridge.md
Outdated
|
|
||
| For the best user experience, you can pre-configure AI Bridge settings in your Coder templates so that users don't need to manually set environment variables. This is especially useful for: | ||
|
|
||
| - **IDE workspaces** (VS Code, Cursor, JetBrains) where AI extensions are used |
Member
There was a problem hiding this comment.
Template settings don't boil down to IDEs by default (except terminal agents like claude).
docs/ai-coder/ai-bridge.md
Outdated
|
|
||
| Configure your AI client to point to your Coder deployment's Bridge endpoints: | ||
|
|
||
| - **OpenAI-compatible clients**: Set `OPENAI_BASE_URL` to `https://coder.example.com/api/v2/api/experimental/aibridge/openai/v1/` |
Contributor
There was a problem hiding this comment.
Indeed; it depends on the client 😞
docs/ai-coder/ai-bridge.md
Outdated
| ) | ||
| ``` | ||
|
|
||
| ### Pre-configuring in Coder Templates |
Contributor
There was a problem hiding this comment.
The Coder-specific use-cases should appear first.
docs/ai-coder/ai-bridge.md
Outdated
| - **Agent workspaces** where tools like Goose or Claude Code run | ||
| - **Development environments** that include AI tooling out of the box | ||
|
|
||
| Coder provides the [`data.coder_workspace_owner.me.session_token`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/workspace_owner) data source which gives you access to the workspace owner's session token. This token automatically authenticates requests through Bridge. |
Contributor
There was a problem hiding this comment.
Suggested change
| Coder provides the [`data.coder_workspace_owner.me.session_token`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/workspace_owner) data source which gives you access to the workspace owner's session token. This token automatically authenticates requests through Bridge. | |
| Coder provides the [`data.coder_workspace_owner.me.session_token`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/workspace_owner) data source which gives you access to the workspace owner's session token. This token is authenticated when requests are routed through AI Bridge. |
docs/ai-coder/ai-bridge.md
Outdated
|
|
||
| #### Configuring AI Agents in Tasks | ||
|
|
||
| For Coder Tasks templates, you can pre-configure agents to use Bridge: |
Contributor
There was a problem hiding this comment.
Suggested change
| For Coder Tasks templates, you can pre-configure agents to use Bridge: | |
| For Coder Tasks templates, you can pre-configure agents to use AI Bridge: |
docs/ai-coder/ai-bridge.md
Outdated
| workdir = "/home/coder/project" | ||
| ai_prompt = data.coder_parameter.ai_prompt.value | ||
| # Use Bridge instead of direct Anthropic API |
Contributor
There was a problem hiding this comment.
Suggested change
| # Use Bridge instead of direct Anthropic API | |
| # Use AI Bridge instead of direct Anthropic API |
docs/ai-coder/ai-bridge.md
Outdated
| claude_api_key = data.coder_workspace_owner.me.session_token | ||
| } | ||
| resource "coder_env" "bridge_base_url" { |
Contributor
There was a problem hiding this comment.
Suggested change
| resource "coder_env" "bridge_base_url" { | |
| resource "coder_env" "ai_bridge_base_url" { |
Member
Author
|
Moving to draft as I am doing a larger refactor and adding more examples for all clients we have tested. |
- Add comprehensive Client Configuration section explaining how to set OPENAI_BASE_URL and ANTHROPIC_BASE_URL to point to AI Bridge - Document authentication using Coder session tokens instead of provider keys - Add configuration examples for Claude Code CLI and custom scripts - Add Pre-configuring in Coder Templates subsection showing how to use data.coder_workspace_owner.me.session_token for automatic setup - Include Terraform example for configuring AI agents in Tasks templates - Fix unbalanced code fence that was causing markdown linting errors
Corrected all AI Bridge client configuration URLs to include the /v1 suffix based on source code verification: - OpenAI: /api/experimental/aibridge/openai/v1 (was missing /v1) - Anthropic: /api/experimental/aibridge/anthropic/v1 (was missing /v1) Verified from enterprise/x/aibridged/aibridged_test.go which shows: - /openai/v1/chat/completions - /anthropic/v1/messages Updated in all configuration examples: - Setting Base URLs section - Claude Code CLI example - Custom Python scripts example - Terraform template example
Corrected Anthropic base URL configuration based on official dogfood template (commit 61fba2d): - Anthropic SDK appends /v1/messages to base URL - Therefore base URL should NOT include /v1 - Verified from dogfood/coder/main.tf which uses: ANTHROPIC_BASE_URL: "https://dev.coder.com/api/experimental/aibridge/anthropic" Final correct URLs: - OpenAI: .../openai/v1 (SDK appends /chat/completions) - Anthropic: .../anthropic (SDK appends /v1/messages) This ensures compatibility with official Anthropic Python SDK and tools like Claude Code that follow the same pattern.
Split AI Bridge documentation from single 530-line file into focused, audience-specific pages for better organization and maintainability. ## Changes ### Structure - Delete single-page docs/ai-coder/ai-bridge.md - Create docs/ai-coder/ai-bridge/ directory with 7 pages: - index.md: Main overview, setup, general config, SDKs, templates - roo-code.md: Roo Code configuration - claude-code.md: Claude Code CLI and VSCode - cursor.md: Cursor IDE - github-copilot.md: GitHub Copilot (VSCode + CLI status) - goose.md: Goose Desktop and CLI - other-clients.md: Kilo Code and unsupported clients ### Content Organization - Platform teams: Server setup in index.md - Template admins: Template patterns in index.md + client pages - End users: Client-specific configuration in dedicated pages - Developers: SDK examples in index.md ### Quality Improvements - Fix all markdown linting errors (8 total) - Remove trailing spaces from all files - Fix broken internal links - Update client table with links to new pages - Use proper heading hierarchy (h4 instead of h5) - Use auto-numbering for ordered lists (1/1/1 style) ### Benefits - Easier maintenance (update one client without affecting others) - Better user experience (focused guides vs scrolling large file) - Clear audience separation (platform/admin/end-user) - Improved navigation (table links to dedicated pages)
1a11811 to
e524206
Compare
Member
Author
|
closing in favour of #20640 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partially written by Claude Code