Create a browser session

curl --request POST \
  --url https://api.onkernel.com/browsers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chrome_policy": {},
  "extensions": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "gpu": false,
  "headless": false,
  "invocation_id": "rr33xuugxj9h0bkf1rdt2bet",
  "kiosk_mode": true,
  "name": "checkout-flow-1",
  "network": {
    "private_hosts": [
      "*.example.ts.net",
      "100.64.0.0/10"
    ]
  },
  "profile": {
    "id": "<string>",
    "name": "<string>",
    "save_changes": false
  },
  "proxy": {
    "id": "<string>",
    "name": "<string>"
  },
  "proxy_id": "<string>",
  "start_url": "https://example.com",
  "stealth": true,
  "tags": {
    "env": "staging",
    "team": "backend"
  },
  "telemetry": {
    "browser": {
      "captcha": {
        "enabled": true
      },
      "connection": {
        "enabled": true
      },
      "console": {
        "enabled": true
      },
      "control": {
        "enabled": true
      },
      "interaction": {
        "enabled": true
      },
      "network": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "screenshot": {
        "enabled": true
      },
      "system": {
        "enabled": true
      }
    },
    "enabled": true,
    "export": {
      "otlp": {
        "destination": {
          "id": "<string>",
          "name": "<string>"
        },
        "enabled": true
      }
    }
  },
  "timeout_seconds": 129605
}
'

import requests

url = "https://api.onkernel.com/browsers"

payload = {
    "chrome_policy": {},
    "extensions": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "gpu": False,
    "headless": False,
    "invocation_id": "rr33xuugxj9h0bkf1rdt2bet",
    "kiosk_mode": True,
    "name": "checkout-flow-1",
    "network": { "private_hosts": ["*.example.ts.net", "100.64.0.0/10"] },
    "profile": {
        "id": "<string>",
        "name": "<string>",
        "save_changes": False
    },
    "proxy": {
        "id": "<string>",
        "name": "<string>"
    },
    "proxy_id": "<string>",
    "start_url": "https://example.com",
    "stealth": True,
    "tags": {
        "env": "staging",
        "team": "backend"
    },
    "telemetry": {
        "browser": {
            "captcha": { "enabled": True },
            "connection": { "enabled": True },
            "console": { "enabled": True },
            "control": { "enabled": True },
            "interaction": { "enabled": True },
            "network": { "enabled": True },
            "page": { "enabled": True },
            "screenshot": { "enabled": True },
            "system": { "enabled": True }
        },
        "enabled": True,
        "export": { "otlp": {
                "destination": {
                    "id": "<string>",
                    "name": "<string>"
                },
                "enabled": True
            } }
    },
    "timeout_seconds": 129605
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chrome_policy: {},
    extensions: [{id: '<string>', name: '<string>'}],
    gpu: false,
    headless: false,
    invocation_id: 'rr33xuugxj9h0bkf1rdt2bet',
    kiosk_mode: true,
    name: 'checkout-flow-1',
    network: {private_hosts: ['*.example.ts.net', '100.64.0.0/10']},
    profile: {id: '<string>', name: '<string>', save_changes: false},
    proxy: {id: '<string>', name: '<string>'},
    proxy_id: '<string>',
    start_url: 'https://example.com',
    stealth: true,
    tags: {env: 'staging', team: 'backend'},
    telemetry: {
      browser: {
        captcha: {enabled: true},
        connection: {enabled: true},
        console: {enabled: true},
        control: {enabled: true},
        interaction: {enabled: true},
        network: {enabled: true},
        page: {enabled: true},
        screenshot: {enabled: true},
        system: {enabled: true}
      },
      enabled: true,
      export: {otlp: {destination: {id: '<string>', name: '<string>'}, enabled: true}}
    },
    timeout_seconds: 129605
  })
};

fetch('https://api.onkernel.com/browsers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/browsers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'chrome_policy' => [
        
    ],
    'extensions' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'gpu' => false,
    'headless' => false,
    'invocation_id' => 'rr33xuugxj9h0bkf1rdt2bet',
    'kiosk_mode' => true,
    'name' => 'checkout-flow-1',
    'network' => [
        'private_hosts' => [
                '*.example.ts.net',
                '100.64.0.0/10'
        ]
    ],
    'profile' => [
        'id' => '<string>',
        'name' => '<string>',
        'save_changes' => false
    ],
    'proxy' => [
        'id' => '<string>',
        'name' => '<string>'
    ],
    'proxy_id' => '<string>',
    'start_url' => 'https://example.com',
    'stealth' => true,
    'tags' => [
        'env' => 'staging',
        'team' => 'backend'
    ],
    'telemetry' => [
        'browser' => [
                'captcha' => [
                                'enabled' => true
                ],
                'connection' => [
                                'enabled' => true
                ],
                'console' => [
                                'enabled' => true
                ],
                'control' => [
                                'enabled' => true
                ],
                'interaction' => [
                                'enabled' => true
                ],
                'network' => [
                                'enabled' => true
                ],
                'page' => [
                                'enabled' => true
                ],
                'screenshot' => [
                                'enabled' => true
                ],
                'system' => [
                                'enabled' => true
                ]
        ],
        'enabled' => true,
        'export' => [
                'otlp' => [
                                'destination' => [
                                                                'id' => '<string>',
                                                                'name' => '<string>'
                                ],
                                'enabled' => true
                ]
        ]
    ],
    'timeout_seconds' => 129605
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onkernel.com/browsers"

	payload := strings.NewReader("{\n  \"chrome_policy\": {},\n  \"extensions\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"gpu\": false,\n  \"headless\": false,\n  \"invocation_id\": \"rr33xuugxj9h0bkf1rdt2bet\",\n  \"kiosk_mode\": true,\n  \"name\": \"checkout-flow-1\",\n  \"network\": {\n    \"private_hosts\": [\n      \"*.example.ts.net\",\n      \"100.64.0.0/10\"\n    ]\n  },\n  \"profile\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"save_changes\": false\n  },\n  \"proxy\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"proxy_id\": \"<string>\",\n  \"start_url\": \"https://example.com\",\n  \"stealth\": true,\n  \"tags\": {\n    \"env\": \"staging\",\n    \"team\": \"backend\"\n  },\n  \"telemetry\": {\n    \"browser\": {\n      \"captcha\": {\n        \"enabled\": true\n      },\n      \"connection\": {\n        \"enabled\": true\n      },\n      \"console\": {\n        \"enabled\": true\n      },\n      \"control\": {\n        \"enabled\": true\n      },\n      \"interaction\": {\n        \"enabled\": true\n      },\n      \"network\": {\n        \"enabled\": true\n      },\n      \"page\": {\n        \"enabled\": true\n      },\n      \"screenshot\": {\n        \"enabled\": true\n      },\n      \"system\": {\n        \"enabled\": true\n      }\n    },\n    \"enabled\": true,\n    \"export\": {\n      \"otlp\": {\n        \"destination\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"enabled\": true\n      }\n    }\n  },\n  \"timeout_seconds\": 129605\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.onkernel.com/browsers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chrome_policy\": {},\n  \"extensions\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"gpu\": false,\n  \"headless\": false,\n  \"invocation_id\": \"rr33xuugxj9h0bkf1rdt2bet\",\n  \"kiosk_mode\": true,\n  \"name\": \"checkout-flow-1\",\n  \"network\": {\n    \"private_hosts\": [\n      \"*.example.ts.net\",\n      \"100.64.0.0/10\"\n    ]\n  },\n  \"profile\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"save_changes\": false\n  },\n  \"proxy\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"proxy_id\": \"<string>\",\n  \"start_url\": \"https://example.com\",\n  \"stealth\": true,\n  \"tags\": {\n    \"env\": \"staging\",\n    \"team\": \"backend\"\n  },\n  \"telemetry\": {\n    \"browser\": {\n      \"captcha\": {\n        \"enabled\": true\n      },\n      \"connection\": {\n        \"enabled\": true\n      },\n      \"console\": {\n        \"enabled\": true\n      },\n      \"control\": {\n        \"enabled\": true\n      },\n      \"interaction\": {\n        \"enabled\": true\n      },\n      \"network\": {\n        \"enabled\": true\n      },\n      \"page\": {\n        \"enabled\": true\n      },\n      \"screenshot\": {\n        \"enabled\": true\n      },\n      \"system\": {\n        \"enabled\": true\n      }\n    },\n    \"enabled\": true,\n    \"export\": {\n      \"otlp\": {\n        \"destination\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"enabled\": true\n      }\n    }\n  },\n  \"timeout_seconds\": 129605\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/browsers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"chrome_policy\": {},\n  \"extensions\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"gpu\": false,\n  \"headless\": false,\n  \"invocation_id\": \"rr33xuugxj9h0bkf1rdt2bet\",\n  \"kiosk_mode\": true,\n  \"name\": \"checkout-flow-1\",\n  \"network\": {\n    \"private_hosts\": [\n      \"*.example.ts.net\",\n      \"100.64.0.0/10\"\n    ]\n  },\n  \"profile\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"save_changes\": false\n  },\n  \"proxy\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"proxy_id\": \"<string>\",\n  \"start_url\": \"https://example.com\",\n  \"stealth\": true,\n  \"tags\": {\n    \"env\": \"staging\",\n    \"team\": \"backend\"\n  },\n  \"telemetry\": {\n    \"browser\": {\n      \"captcha\": {\n        \"enabled\": true\n      },\n      \"connection\": {\n        \"enabled\": true\n      },\n      \"console\": {\n        \"enabled\": true\n      },\n      \"control\": {\n        \"enabled\": true\n      },\n      \"interaction\": {\n        \"enabled\": true\n      },\n      \"network\": {\n        \"enabled\": true\n      },\n      \"page\": {\n        \"enabled\": true\n      },\n      \"screenshot\": {\n        \"enabled\": true\n      },\n      \"system\": {\n        \"enabled\": true\n      }\n    },\n    \"enabled\": true,\n    \"export\": {\n      \"otlp\": {\n        \"destination\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"enabled\": true\n      }\n    }\n  },\n  \"timeout_seconds\": 129605\n}"

response = http.request(request)
puts response.read_body

{
  "cdp_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi...",
  "created_at": "2023-11-07T05:31:56Z",
  "headless": false,
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "stealth": false,
  "timeout_seconds": 123,
  "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi...",
  "base_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel",
  "browser_live_view_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi...",
  "chrome_policy": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "gpu": false,
  "kiosk_mode": false,
  "name": "checkout-flow-1",
  "network": {
    "private_hosts": [
      "*.example.ts.net",
      "100.64.0.0/10"
    ]
  },
  "pool": {
    "id": "<string>",
    "name": "<string>"
  },
  "profile": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "last_used_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "profile_save_changes": true,
  "proxy": {
    "id": "<string>",
    "name": "<string>"
  },
  "proxy_id": "<string>",
  "start_url": "https://example.com",
  "tags": {
    "env": "staging",
    "team": "backend"
  },
  "telemetry": {
    "browser": {
      "captcha": {
        "enabled": true
      },
      "connection": {
        "enabled": true
      },
      "console": {
        "enabled": true
      },
      "control": {
        "enabled": true
      },
      "interaction": {
        "enabled": true
      },
      "network": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "screenshot": {
        "enabled": true
      },
      "system": {
        "enabled": true
      }
    },
    "export": {
      "otlp": {
        "destination": "<string>",
        "enabled": true
      }
    }
  },
  "usage": {
    "uptime_ms": 123
  },
  "viewport": {
    "height": 800,
    "width": 1280,
    "refresh_rate": 60
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

POST

browsers

Create a browser session

curl --request POST \
  --url https://api.onkernel.com/browsers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chrome_policy": {},
  "extensions": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "gpu": false,
  "headless": false,
  "invocation_id": "rr33xuugxj9h0bkf1rdt2bet",
  "kiosk_mode": true,
  "name": "checkout-flow-1",
  "network": {
    "private_hosts": [
      "*.example.ts.net",
      "100.64.0.0/10"
    ]
  },
  "profile": {
    "id": "<string>",
    "name": "<string>",
    "save_changes": false
  },
  "proxy": {
    "id": "<string>",
    "name": "<string>"
  },
  "proxy_id": "<string>",
  "start_url": "https://example.com",
  "stealth": true,
  "tags": {
    "env": "staging",
    "team": "backend"
  },
  "telemetry": {
    "browser": {
      "captcha": {
        "enabled": true
      },
      "connection": {
        "enabled": true
      },
      "console": {
        "enabled": true
      },
      "control": {
        "enabled": true
      },
      "interaction": {
        "enabled": true
      },
      "network": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "screenshot": {
        "enabled": true
      },
      "system": {
        "enabled": true
      }
    },
    "enabled": true,
    "export": {
      "otlp": {
        "destination": {
          "id": "<string>",
          "name": "<string>"
        },
        "enabled": true
      }
    }
  },
  "timeout_seconds": 129605
}
'

import requests

url = "https://api.onkernel.com/browsers"

payload = {
    "chrome_policy": {},
    "extensions": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "gpu": False,
    "headless": False,
    "invocation_id": "rr33xuugxj9h0bkf1rdt2bet",
    "kiosk_mode": True,
    "name": "checkout-flow-1",
    "network": { "private_hosts": ["*.example.ts.net", "100.64.0.0/10"] },
    "profile": {
        "id": "<string>",
        "name": "<string>",
        "save_changes": False
    },
    "proxy": {
        "id": "<string>",
        "name": "<string>"
    },
    "proxy_id": "<string>",
    "start_url": "https://example.com",
    "stealth": True,
    "tags": {
        "env": "staging",
        "team": "backend"
    },
    "telemetry": {
        "browser": {
            "captcha": { "enabled": True },
            "connection": { "enabled": True },
            "console": { "enabled": True },
            "control": { "enabled": True },
            "interaction": { "enabled": True },
            "network": { "enabled": True },
            "page": { "enabled": True },
            "screenshot": { "enabled": True },
            "system": { "enabled": True }
        },
        "enabled": True,
        "export": { "otlp": {
                "destination": {
                    "id": "<string>",
                    "name": "<string>"
                },
                "enabled": True
            } }
    },
    "timeout_seconds": 129605
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chrome_policy: {},
    extensions: [{id: '<string>', name: '<string>'}],
    gpu: false,
    headless: false,
    invocation_id: 'rr33xuugxj9h0bkf1rdt2bet',
    kiosk_mode: true,
    name: 'checkout-flow-1',
    network: {private_hosts: ['*.example.ts.net', '100.64.0.0/10']},
    profile: {id: '<string>', name: '<string>', save_changes: false},
    proxy: {id: '<string>', name: '<string>'},
    proxy_id: '<string>',
    start_url: 'https://example.com',
    stealth: true,
    tags: {env: 'staging', team: 'backend'},
    telemetry: {
      browser: {
        captcha: {enabled: true},
        connection: {enabled: true},
        console: {enabled: true},
        control: {enabled: true},
        interaction: {enabled: true},
        network: {enabled: true},
        page: {enabled: true},
        screenshot: {enabled: true},
        system: {enabled: true}
      },
      enabled: true,
      export: {otlp: {destination: {id: '<string>', name: '<string>'}, enabled: true}}
    },
    timeout_seconds: 129605
  })
};

fetch('https://api.onkernel.com/browsers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/browsers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'chrome_policy' => [
        
    ],
    'extensions' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'gpu' => false,
    'headless' => false,
    'invocation_id' => 'rr33xuugxj9h0bkf1rdt2bet',
    'kiosk_mode' => true,
    'name' => 'checkout-flow-1',
    'network' => [
        'private_hosts' => [
                '*.example.ts.net',
                '100.64.0.0/10'
        ]
    ],
    'profile' => [
        'id' => '<string>',
        'name' => '<string>',
        'save_changes' => false
    ],
    'proxy' => [
        'id' => '<string>',
        'name' => '<string>'
    ],
    'proxy_id' => '<string>',
    'start_url' => 'https://example.com',
    'stealth' => true,
    'tags' => [
        'env' => 'staging',
        'team' => 'backend'
    ],
    'telemetry' => [
        'browser' => [
                'captcha' => [
                                'enabled' => true
                ],
                'connection' => [
                                'enabled' => true
                ],
                'console' => [
                                'enabled' => true
                ],
                'control' => [
                                'enabled' => true
                ],
                'interaction' => [
                                'enabled' => true
                ],
                'network' => [
                                'enabled' => true
                ],
                'page' => [
                                'enabled' => true
                ],
                'screenshot' => [
                                'enabled' => true
                ],
                'system' => [
                                'enabled' => true
                ]
        ],
        'enabled' => true,
        'export' => [
                'otlp' => [
                                'destination' => [
                                                                'id' => '<string>',
                                                                'name' => '<string>'
                                ],
                                'enabled' => true
                ]
        ]
    ],
    'timeout_seconds' => 129605
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onkernel.com/browsers"

	payload := strings.NewReader("{\n  \"chrome_policy\": {},\n  \"extensions\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"gpu\": false,\n  \"headless\": false,\n  \"invocation_id\": \"rr33xuugxj9h0bkf1rdt2bet\",\n  \"kiosk_mode\": true,\n  \"name\": \"checkout-flow-1\",\n  \"network\": {\n    \"private_hosts\": [\n      \"*.example.ts.net\",\n      \"100.64.0.0/10\"\n    ]\n  },\n  \"profile\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"save_changes\": false\n  },\n  \"proxy\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"proxy_id\": \"<string>\",\n  \"start_url\": \"https://example.com\",\n  \"stealth\": true,\n  \"tags\": {\n    \"env\": \"staging\",\n    \"team\": \"backend\"\n  },\n  \"telemetry\": {\n    \"browser\": {\n      \"captcha\": {\n        \"enabled\": true\n      },\n      \"connection\": {\n        \"enabled\": true\n      },\n      \"console\": {\n        \"enabled\": true\n      },\n      \"control\": {\n        \"enabled\": true\n      },\n      \"interaction\": {\n        \"enabled\": true\n      },\n      \"network\": {\n        \"enabled\": true\n      },\n      \"page\": {\n        \"enabled\": true\n      },\n      \"screenshot\": {\n        \"enabled\": true\n      },\n      \"system\": {\n        \"enabled\": true\n      }\n    },\n    \"enabled\": true,\n    \"export\": {\n      \"otlp\": {\n        \"destination\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"enabled\": true\n      }\n    }\n  },\n  \"timeout_seconds\": 129605\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.onkernel.com/browsers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chrome_policy\": {},\n  \"extensions\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"gpu\": false,\n  \"headless\": false,\n  \"invocation_id\": \"rr33xuugxj9h0bkf1rdt2bet\",\n  \"kiosk_mode\": true,\n  \"name\": \"checkout-flow-1\",\n  \"network\": {\n    \"private_hosts\": [\n      \"*.example.ts.net\",\n      \"100.64.0.0/10\"\n    ]\n  },\n  \"profile\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"save_changes\": false\n  },\n  \"proxy\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"proxy_id\": \"<string>\",\n  \"start_url\": \"https://example.com\",\n  \"stealth\": true,\n  \"tags\": {\n    \"env\": \"staging\",\n    \"team\": \"backend\"\n  },\n  \"telemetry\": {\n    \"browser\": {\n      \"captcha\": {\n        \"enabled\": true\n      },\n      \"connection\": {\n        \"enabled\": true\n      },\n      \"console\": {\n        \"enabled\": true\n      },\n      \"control\": {\n        \"enabled\": true\n      },\n      \"interaction\": {\n        \"enabled\": true\n      },\n      \"network\": {\n        \"enabled\": true\n      },\n      \"page\": {\n        \"enabled\": true\n      },\n      \"screenshot\": {\n        \"enabled\": true\n      },\n      \"system\": {\n        \"enabled\": true\n      }\n    },\n    \"enabled\": true,\n    \"export\": {\n      \"otlp\": {\n        \"destination\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"enabled\": true\n      }\n    }\n  },\n  \"timeout_seconds\": 129605\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/browsers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"chrome_policy\": {},\n  \"extensions\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"gpu\": false,\n  \"headless\": false,\n  \"invocation_id\": \"rr33xuugxj9h0bkf1rdt2bet\",\n  \"kiosk_mode\": true,\n  \"name\": \"checkout-flow-1\",\n  \"network\": {\n    \"private_hosts\": [\n      \"*.example.ts.net\",\n      \"100.64.0.0/10\"\n    ]\n  },\n  \"profile\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"save_changes\": false\n  },\n  \"proxy\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"proxy_id\": \"<string>\",\n  \"start_url\": \"https://example.com\",\n  \"stealth\": true,\n  \"tags\": {\n    \"env\": \"staging\",\n    \"team\": \"backend\"\n  },\n  \"telemetry\": {\n    \"browser\": {\n      \"captcha\": {\n        \"enabled\": true\n      },\n      \"connection\": {\n        \"enabled\": true\n      },\n      \"console\": {\n        \"enabled\": true\n      },\n      \"control\": {\n        \"enabled\": true\n      },\n      \"interaction\": {\n        \"enabled\": true\n      },\n      \"network\": {\n        \"enabled\": true\n      },\n      \"page\": {\n        \"enabled\": true\n      },\n      \"screenshot\": {\n        \"enabled\": true\n      },\n      \"system\": {\n        \"enabled\": true\n      }\n    },\n    \"enabled\": true,\n    \"export\": {\n      \"otlp\": {\n        \"destination\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"enabled\": true\n      }\n    }\n  },\n  \"timeout_seconds\": 129605\n}"

response = http.request(request)
puts response.read_body

{
  "cdp_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi...",
  "created_at": "2023-11-07T05:31:56Z",
  "headless": false,
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "stealth": false,
  "timeout_seconds": 123,
  "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi...",
  "base_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel",
  "browser_live_view_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi...",
  "chrome_policy": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "gpu": false,
  "kiosk_mode": false,
  "name": "checkout-flow-1",
  "network": {
    "private_hosts": [
      "*.example.ts.net",
      "100.64.0.0/10"
    ]
  },
  "pool": {
    "id": "<string>",
    "name": "<string>"
  },
  "profile": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "last_used_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "profile_save_changes": true,
  "proxy": {
    "id": "<string>",
    "name": "<string>"
  },
  "proxy_id": "<string>",
  "start_url": "https://example.com",
  "tags": {
    "env": "staging",
    "team": "backend"
  },
  "telemetry": {
    "browser": {
      "captcha": {
        "enabled": true
      },
      "connection": {
        "enabled": true
      },
      "console": {
        "enabled": true
      },
      "control": {
        "enabled": true
      },
      "interaction": {
        "enabled": true
      },
      "network": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "screenshot": {
        "enabled": true
      },
      "system": {
        "enabled": true
      }
    },
    "export": {
      "otlp": {
        "destination": "<string>",
        "enabled": true
      }
    }
  },
  "usage": {
    "uptime_ms": 123
  },
  "viewport": {
    "height": 800,
    "width": 1280,
    "refresh_rate": 60
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters for creating a browser session.

chrome_policy

object

Custom Chrome enterprise policy overrides applied to this browser session. Keys are Chrome enterprise policy names; values must match their expected types. Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See https://chromeenterprise.google/policies/

extensions

object[]

List of browser extensions to load into the session. Provide each by id or name.

Maximum array length: 20

Extension selection for the browser session. Provide either id or name of an extension uploaded to Kernel.

Option 1
Option 2

Show child attributes

gpu

boolean

If true, enables GPU acceleration for the browser session. Requires Start-Up or Enterprise plan and headless=false.

Example:

false

headless

boolean

If true, launches the browser using a headless image (no VNC/GUI). Defaults to false.

Example:

false

invocation_id

string

action invocation ID

Example:

"rr33xuugxj9h0bkf1rdt2bet"

kiosk_mode

boolean

If true, launches the browser in kiosk mode to hide address bar and tabs in live view.

Example:

true

name

string

Optional human-readable name for the browser session, used to find it later in the dashboard. Must be unique among active sessions within the project. Can be changed later via PATCH /browsers/{id_or_name}.

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9._-]{1,255}$

Example:

"checkout-flow-1"

network

object

Network configuration for the browser session. Cannot be changed after creation.

Show child attributes

profile

object

Profile selection for the browser session. Provide either id or name. If specified, the matching profile will be loaded into the browser session. Profiles must be created beforehand.

Option 1
Option 2

Show child attributes

proxy

object

Proxy configuration for the browser session. Cannot be combined with proxy_id. Omit to use the browser default: stealth browsers use Kernel's default stealth proxy, while non-stealth browsers use direct egress. Set mode to direct to force direct egress regardless of stealth. Set mode to default to explicitly use the browser default: Kernel's default stealth proxy when stealth=true, or direct egress when stealth=false. Select id or name to use that proxy regardless of stealth. Proxy selection does not change stealth or CAPTCHA solver behavior.

Option 1
Option 2
Option 3

Show child attributes

proxy_id

string

deprecated

Optional proxy to associate to the browser session. Must reference a proxy in the same project as the browser session. Deprecated in favor of proxy.

region

enum<string>

Geographic region for the browser session. It is fixed once the session is created. Region selection requires a Start-Up or Enterprise plan, defaults to us-east when omitted on create.

Available options:

us-east,

eu-west

start_url

string

Optional URL to open when the browser session is created. Navigation is best-effort, so navigation failures do not prevent the session from being created.

Example:

"https://example.com"

stealth

boolean

If true, launches the browser in stealth mode and enables the CAPTCHA solver. Defaults to false. When proxy is omitted, stealth browsers use Kernel's default stealth proxy and non-stealth browsers use direct egress. An explicit proxy configuration changes only egress; it does not enable or disable stealth or the CAPTCHA solver.

Example:

true

Response

Successful response

cdp_ws_url

string

required

Websocket URL for Chrome DevTools Protocol connections to the browser session

Example:

"wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi..."

created_at

string<date-time>

required

When the browser session was created.

headless

boolean

required

Whether the browser session is running in headless mode.

Example:

false

region

enum<string>

required

Geographic region of the browser session. Fixed once the session is created.

Available options:

us-east,

eu-west

session_id

string

required

Unique identifier for the browser session

Example:

"htzv5orfit78e1m2biiifpbv"

stealth

boolean

required

Whether the browser session is running in stealth mode.

Example:

false

timeout_seconds

integer

required

The number of seconds of inactivity before the browser session is terminated.

webdriver_ws_url

string

required

Websocket URL for WebDriver BiDi connections to the browser session

Example:

"wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi..."

base_url

string

Metro-API HTTP base URL for this browser session.

Example:

"https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel"

browser_live_view_url

string

Remote URL for live viewing the browser session. Only available for non-headless browsers.

Example:

"https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi..."

chrome_policy

object

Custom Chrome enterprise policy overrides that were applied to this browser session, if any. Echoed back for verification. Keys are Chrome enterprise policy names.

deleted_at

string<date-time>

When the browser session was soft-deleted. Only present for deleted sessions.

gpu

boolean

Whether GPU acceleration is enabled for the browser session (only supported for headful sessions).

Example:

false

kiosk_mode

boolean

Whether the browser session is running in kiosk mode.

Example:

false

name

string

Human-readable name of the browser session, if one was set at creation.

Example:

"checkout-flow-1"

network

object

Network configuration the session was created with, if any. Omitted when the session has no network configuration.

Show child attributes

pool

object

Browser pool this session was acquired from, if any.

Show child attributes

profile

object

Browser profile metadata.

Show child attributes

profile_save_changes

boolean

Whether changes made during this browser session are saved back to its profile when the session ends. Omitted when no profile is attached.

proxy

object

Resolved proxy configuration for this browser session.

Option 1
Option 2
Option 3

Show child attributes

proxy_id

string

deprecated

ID of the proxy associated with this browser session, if any. Deprecated in favor of proxy.

start_url

string

URL the session was asked to navigate to on creation, if any. Recorded for debugging. Navigation is fire-and-forget — the URL is dispatched to the browser without waiting for it to load, and any errors (DNS failure, bad status, timeout) are silently dropped. Captures what was requested, not what the browser actually loaded.

Example:

"https://example.com"

Apps

Audit Logs

Managed Auth

Authentication

Browser Pools

Browsers

Browser Computer Controls

Browser Filesystem

Browser Logs

Browser Playwright

Browser Processes

Browser Replays

Browser Telemetry

Deployments

Extensions

Invocations

API Keys

Organization

Projects

Profiles

Proxies

Create a browser session

Authorizations

Body

Response