NotificationsYou must be signed in to change notification settings
Fork1.1k
Star11.4k

docs: add client configuration section and examples to AI Bridge#20340

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Closed

matifali wants to merge6 commits intomainfromaibridge-provider-docs

Closed

docs: add client configuration section and examples to AI Bridge#20340

matifali wants to merge6 commits intomainfromaibridge-provider-docs

Conversation

Copy link

Member

matifali commentedOct 16, 2025•
edited
Loading

Partially written by Claude Code

github-actionsbot assignedmatifali

Oct 16, 2025

matifali requested review fromdavid-fraley,deansheather andstirby

October 16, 2025 13:39

deansheather reviewed

Oct 16, 2025

View reviewed changes

docs/ai-coder/ai-bridge.md OutdatedShow resolvedHide resolved

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/`

Copy link

Member

deansheatherOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Sometimes it's just.../aibridge/openai and not.../aibrdige/openai/v1

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Indeed; it depends on the client 😞

docs/ai-coder/ai-bridge.md OutdatedShow resolvedHide resolved

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


		###Authentication

		Instead of using provider-specific API keys (OpenAI/Anthropic keys), clients authenticate using yourCoder session token orAPI key:

Copy link

Member

deansheatherOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	Instead of using provider-specific API keys (OpenAI/Anthropic keys), clients authenticate usingyourCoder session token orAPI key:
	Instead of using provider-specific API keys (OpenAI/Anthropic keys), clients authenticate usingtheirCoder session token orAPI 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

Copy link

Member

deansheatherOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Template settings don't boil down to IDEs by default (except terminal agents likeclaude).

dannykopping reviewed

Oct 16, 2025

View reviewed changes

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/`

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Indeed; it depends on the client 😞

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

		)
		```

		###Pre-configuring in Coder Templates

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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 tokenautomatically authenticatesrequests 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 tokenis authenticated whenrequestsare routedthrough 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:

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	For Coder Tasks templates, you can pre-configure agents to use Bridge:
	For Coder Tasks templates, you can pre-configure agents to useAIBridge:

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

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	#Use Bridge instead of direct Anthropic API
	#UseAIBridge 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" {

Copy link

Contributor

dannykoppingOct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	resource "coder_env" "bridge_base_url" {
	resource "coder_env" "ai_bridge_base_url" {

matifali marked this pull request as draft

October 16, 2025 14:58

Copy link

MemberAuthor

matifali commentedOct 16, 2025

Moving to draft as I am doing a larger refactor and adding more examples for all clients we have tested.

matifaliand others added6 commits

October 22, 2025 10:48

docs: add client configuration section and examples to AI Bridge

420c4c2

docs(ai-bridge): add client configuration section with template examples

f8d94c9

- 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

fixup!

5224a14

docs(ai-bridge): fix base URLs to include /v1 suffix

c2a2725

Corrected all AI Bridge client configuration URLs to include the /v1suffix 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/messagesUpdated in all configuration examples:- Setting Base URLs section- Claude Code CLI example- Custom Python scripts example- Terraform template example

docs(ai-bridge): fix Anthropic base URL - remove /v1 suffix

c674b93

Corrected Anthropic base URL configuration based on official dogfoodtemplate (commit61fba2d):- 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 andtools like Claude Code that follow the same pattern.

docs(ai-bridge): restructure into multi-page documentation

e524206

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)

matifali force-pushed theaibridge-provider-docs branch from1a11811 toe524206Compare

October 22, 2025 05:49