Skip to content

Document the WebSocket responses opt-out #4770

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

Open
1fanwang wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −0
Open

Document the WebSocket responses opt-out #4770

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba0fa97
Document the WebSocket responses opt-out
1fanwang Sep 8, 2026
d446294
Add PowerShell form and clarify the SDK option polarity
1fanwang Sep 8, 2026
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,27 @@ Launch `copilot` in a folder that contains code you want to work with.

By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5.

#### Falling back to the HTTP responses transport

Models that advertise a WebSocket responses endpoint use it by default. If your
network blocks WebSocket connections, or a session starts failing with
`400 input item ID does not belong to this connection`, set this variable to use
the HTTP responses transport instead:

```bash
export COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES=true
```

On Windows, using PowerShell:

```powershell
$env:COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES = "true"
```

Setting this to `true` has the same effect as setting the SDK's
`capi.enableWebSocketResponses` session option to `false`. The two have opposite
polarity, so enabling this variable disables the WebSocket transport.

### Experimental Mode

Experimental mode enables access to new features that are still in development. You can activate experimental mode by:
Expand Down