Skip to content

docs: clarify Azure project URL support #2593

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

Draft
roji wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Draft

docs: clarify Azure project URL support #2593

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
6 changes: 3 additions & 3 deletions docs/auth/byok.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,8 @@ Anthropic models always use the Anthropic Messages API regardless of this settin

**Azure (`type: "azure"`)**
* Use for native Azure OpenAI endpoints
* `baseUrl` should be just the host (e.g., `https://my-resource.openai.azure.com`)
* Do NOT include `/openai/v1` in the URL—the SDK handles path construction
* `baseUrl` / `base_url` accepts a resource host or a full project URL, such as `https://<host>/api/projects/hosted-agents-ncus`, with or without a trailing slash.
* The runtime preserves the project prefix when constructing Azure API paths. For `wireApi: "responses"` with `azure.apiVersion` omitted, the project URL above produces `https://<host>/api/projects/hosted-agents-ncus/openai/v1/responses`. Project URLs require an updated Copilot CLI runtime.
Comment thread
roji marked this conversation as resolved.

**Anthropic (`type: "anthropic"`)**
* For direct Anthropic API access
Expand All @@ -252,7 +252,7 @@ Use `type: "azure"` for endpoints at `*.openai.azure.com`:
```typescript
provider: {
type: "azure",
baseUrl: "https://my-resource.openai.azure.com", // Just the host
baseUrl: "https://my-resource.openai.azure.com", // Resource host or full project URL
apiKey: process.env.AZURE_OPENAI_KEY,
azure: {
apiVersion: "2024-10-21",
Expand Down
Loading