Skip to content

Commit e9b4116

Browse files
ShawnPanaclaude
andcommitted
docs: fix custom proxy param names to dot-notation, add discovery URL example
Use customProxy.{url,username,password} (dot-notation) to match what the WSS proxy actually forwards to the Browser API. Add concrete HTTPS URL for CDP discovery endpoint. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e12db5f commit e9b4116

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/cloud/guides/browser-api.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,17 @@ await browser.close();
7474
| `timeout` | `int` | Session timeout in minutes. Max: 240 (4 hours). |
7575
| `browserScreenWidth` | `int` | Browser width in pixels. |
7676
| `browserScreenHeight` | `int` | Browser height in pixels. |
77-
| `proxyUrl` | `string` | Custom proxy URL (HTTP or SOCKS5). |
78-
| `proxyUsername` | `string` | Username for the custom proxy. |
79-
| `proxyPassword` | `string` | Password for the custom proxy. |
77+
| `customProxy.url` | `string` | Custom proxy URL (HTTP or SOCKS5). |
78+
| `customProxy.username` | `string` | Username for the custom proxy. |
79+
| `customProxy.password` | `string` | Password for the custom proxy. |
8080

8181
### How it works
8282

8383
The browser is automatically created when you connect and automatically stopped when the WebSocket disconnects. No need to call any API to start or stop the browser.
8484

8585
<Tip>
86-
CDP discovery endpoints (`/json/version`, `/json/list`) are also exposed over HTTPS for tools that use HTTP auto-discovery.
86+
CDP discovery endpoints are also exposed over HTTPS for tools that use HTTP auto-discovery:
87+
`https://connect.browser-use.com/json/version?apiKey=YOUR_API_KEY`
8788
</Tip>
8889

8990
## SDK

0 commit comments

Comments
 (0)