Skip to content

Commit 89b8f93

Browse files
committed
Merge remote-tracking branch 'origin/tembo/create-sdk-docs-for-proxies-feature-configure-proxy-page' into tembo/create-sdk-docs-for-proxies-feature-configure-proxy-page
2 parents bb947ff + e8d8e6e commit 89b8f93

File tree

8 files changed

+43
-137
lines changed

8 files changed

+43
-137
lines changed

browsers/proxies.mdx

Lines changed: 0 additions & 94 deletions
This file was deleted.

browsers/stealth.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: "Stealth Mode"
33
---
44

5-
Kernel browsers can be configured to `stealth` mode, which adds a high performant residential proxy and auto-CAPTCHA solver to your instances.
5+
Kernel browsers can be configured to `stealth` mode, which adds our recommended proxy configuration to your browser instances. It also adds a `reCAPTCHA solver` to the browser, so it automatically solves [reCAPTCHAs](https://www.google.com/recaptcha/api2/demo) on your behalf.
66

7-
To turn on stealth mode, set its flag in your app code when instantiating Kernel:
7+
To turn on stealth mode, set its flag when instantiating Kernel browsers:
88

99
<CodeGroup>
1010
```typescript Typescript/Javascript
@@ -23,4 +23,6 @@ kernel_browser = client.browsers.create(invocation_id=ctx.invocation_id, stealth
2323
[Anthropic Computer Use](/quickstart#sample-apps-reference) stops when it runs into a CAPTCHA. Use Kernel's auto-captcha solver by adding this to your prompt:
2424

2525
`"If you see a CAPTCHA or similar test, just wait for it to get solved automatically by the browser."`
26-
</Info>
26+
</Info>
27+
28+
If you're looking for proxy-level configuration with Kernel browsers, see [Proxies](/proxies/overview).

docs.json

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,26 +56,30 @@
5656
"pages": [
5757
"browsers/create-a-browser",
5858
"browsers/headless",
59-
"browsers/stealth",
6059
"browsers/standby",
6160
"browsers/persistence",
6261
"browsers/profiles",
63-
"browsers/proxies",
6462
"browsers/termination",
6563
"browsers/file-io",
6664
"browsers/live-view",
67-
"browsers/replays"
68-
]
69-
},
70-
{
71-
"group": "Proxies",
72-
"pages": [
73-
"proxies/overview",
74-
"proxies/datacenter",
75-
"proxies/isp",
76-
"proxies/residential",
77-
"proxies/mobile",
78-
"proxies/custom"
65+
"browsers/replays",
66+
{
67+
"group": "Bot Anti-Detection",
68+
"pages": [
69+
"browsers/stealth",
70+
{
71+
"group": "Proxies",
72+
"pages": [
73+
"proxies/overview",
74+
"proxies/custom",
75+
"proxies/mobile",
76+
"proxies/residential",
77+
"proxies/isp",
78+
"proxies/datacenter"
79+
]
80+
}
81+
]
82+
}
7983
]
8084
},
8185
{

proxies/custom.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Custom proxies allow you to use your own proxy servers with Kernel browsers. Thi
66

77
## Configuration
88

9-
<Note>
9+
<Tip>
1010
Currently, only HTTPS proxies are supported for custom proxy configurations.
11-
</Note>
11+
</Tip>
1212

1313
Specify the host, port, and optional authentication credentials for your proxy server:
1414

@@ -63,6 +63,6 @@ browser = client.browsers.create(
6363
- **`username`** - Username for proxy authentication
6464
- **`password`** - Password for proxy authentication (minimum 5 characters)
6565

66-
<Note>
66+
<Info>
6767
When creating a proxy with authentication, provide the password. The API response will only indicate if a password exists (`has_password: true`) but won't return the actual password for security reasons.
68-
</Note>
68+
</Info>

proxies/isp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "ISP Proxies"
33
---
44

5-
ISP proxies use residential IP addresses hosted on high-speed servers, purchased or leased from Internet Service Providers for commercial use. Target sites classify them as residential IPs, allowing you to access websites like a real user while maintaining the speed and reliability of datacenter infrastructure. They're ideal when datacenter proxies are blocked but you still need fast, cost-effective proxies.
5+
ISP (Internet Service Provider) proxies combine the speed of datacenter proxies with better legitimacy, as they use IP addresses assigned by real ISPs.
66

77
## Configuration
88

proxies/mobile.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ browser = client.browsers.create(
5555
## Configuration Parameters
5656

5757
- **`country`** - ISO 3166 country code
58-
- **`carrier`** - Mobile carrier name (e.g., `verizon`, `att`, `tmobile`)
58+
- **`carrier`** - Mobile carrier name (see available carriers below)
5959
- **`state`** - Two-letter state code. Only supported for US and Australia. Cannot be used with `city`
6060
- **`city`** - City name (lowercase, no spaces, e.g., `newyork`, `losangeles`). Required if `zip` is provided
6161
- **`zip`** - US ZIP code (5 digits). Requires `city` to be provided
6262
- **`asn`** - Autonomous System Number. Mutually exclusive with geo-location targeting
6363

6464
## Supported Carriers
6565

66-
Major carriers worldwide are supported, including:
66+
Major carriers worldwide are supported:
6767

6868
**US Carriers:**
6969
- `att` - AT&T

proxies/overview.mdx

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,26 @@
11
---
2-
title: "Proxies Overview"
2+
title: "Overview"
33
---
44

55
import CreateProxySnippet from '/snippets/openapi/post-proxies.mdx';
66
import ListProxiesSnippet from '/snippets/openapi/get-proxies.mdx';
77
import DeleteProxySnippet from '/snippets/openapi/delete-proxies-id.mdx';
88

9-
Kernel proxies enable you to route browser traffic through different types of proxy servers, providing enhanced privacy, geographic flexibility, and bot detection avoidance. Proxies can be created once and reused across multiple browser sessions.
9+
Kernel proxies enable you to route browser traffic through different types of proxy servers, providing enhanced privacy, flexibility, and bot detection avoidance. Proxies can be created once and reused across multiple browser sessions.
1010

1111
## Proxy Types
1212

13-
Kernel supports five types of proxies, ranked by quality for avoiding bot detection (from best to worst):
13+
Kernel supports five types of proxies, ranked by quality (from best to worst):
1414

15-
1. **Mobile** - Traffic routed through mobile carrier networks
16-
2. **Residential** - Traffic routed through residential ISP connections
17-
3. **ISP** - Traffic routed through ISP data centers
18-
4. **Datacenter** - Traffic routed through commercial data centers
19-
5. **Custom** - Your own proxy servers
15+
0. [**Custom**](/proxies/custom) - Your own proxy servers
16+
1. [**Mobile**](/proxies/mobile) - Traffic routed through mobile carrier networks
17+
2. [**Residential**](/proxies/residential) - Traffic routed through residential ISP connections
18+
3. [**ISP**](/proxies/isp) - Traffic routed through ISP data centers
19+
4. [**Datacenter**](/proxies/datacenter) - Traffic routed through commercial data centers
2020

2121
## 1. Create a proxy
2222

23-
<Info>
24-
First, install the Kernel SDK:
25-
- Typescript/Javascript: `npm install @onkernel/sdk`
26-
- Python: `pip install kernel`
27-
</Info>
28-
29-
Create a proxy configuration that can be reused across browser sessions:
23+
Create a proxy configuration from the types above that can be reused across browser sessions:
3024

3125
<CreateProxySnippet />
3226

@@ -88,6 +82,6 @@ When no longer needed, delete the proxy configuration:
8882

8983
<DeleteProxySnippet />
9084

91-
<Note>
92-
Deleting a proxy does not affect existing browser sessions that are using it. The proxy configuration is only removed from your organization.
93-
</Note>
85+
<Info>
86+
Deleting a proxy does not affect existing browser sessions that are currently using it. The configuration is only removed from your organization so it can't be used in future browser sessions.
87+
</Info>

proxies/residential.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Residential Proxies"
33
---
44

5-
Residential proxies use real IPs from people who opt-in and are rewarded for lending their IP to the network. This allows you to target sophisticated, hard-to-reach websites with local IPs from the target area, helping you browse or collect data as a real person would. They're ideal when datacenter or ISP proxies result in low success rates or get blocked.
5+
Residential proxies route traffic through real residential IP addresses. They support advanced targeting options including city, state, and operating system.
66

77
## Configuration
88

0 commit comments

Comments
 (0)