Execute Playwright/TypeScript code against the browser

curl --request POST \
  --url https://api.onkernel.com/browsers/{id_or_name}/playwright/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "executor": "checkout",
  "timeout_sec": 60
}
'

import requests

url = "https://api.onkernel.com/browsers/{id_or_name}/playwright/execute"

payload = {
    "code": "<string>",
    "executor": "checkout",
    "timeout_sec": 60
}
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({code: '<string>', executor: 'checkout', timeout_sec: 60})
};

fetch('https://api.onkernel.com/browsers/{id_or_name}/playwright/execute', 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/{id_or_name}/playwright/execute",
  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([
    'code' => '<string>',
    'executor' => 'checkout',
    'timeout_sec' => 60
  ]),
  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/{id_or_name}/playwright/execute"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"executor\": \"checkout\",\n  \"timeout_sec\": 60\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/{id_or_name}/playwright/execute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"executor\": \"checkout\",\n  \"timeout_sec\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/browsers/{id_or_name}/playwright/execute")

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  \"code\": \"<string>\",\n  \"executor\": \"checkout\",\n  \"timeout_sec\": 60\n}"

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

{
  "success": true,
  "error": "<string>",
  "result": "<unknown>",
  "stderr": "<string>",
  "stdout": "<string>",
  "tab": {
    "created": true,
    "target_id": "<string>"
  }
}

{
  "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"
  }
}

{
  "executors": [
    {
      "busy": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "name": "checkout",
      "target_id": "<string>",
      "url": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "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": "invalid_request",
  "message": "<string>"
}

Browser Playwright

Execute Playwright/TypeScript code against the browser

Execute arbitrary Playwright code in a fresh execution context against the browser. The code runs in the same VM as the browser, minimizing latency and maximizing throughput. It has access to 'page', 'context', 'browser', and 'webmcp' variables. Use 'webmcp.listTools()' to discover browser-wide WebMCP tools and 'webmcp.invokeTool(toolRef, input?, { timeoutSec? })' to invoke an exact registration. It can `return` a value, and this value is returned in the response. Every call runs in an executor: a dedicated Node.js process with its own browser connection. Calls on different executors run concurrently; calls on the same executor run one at a time. A timeout, crash, or blocked event loop in one executor does not affect other executors. After a timeout the executor keeps its process and drops its browser connection, so code abandoned by the timeout cannot keep driving the browser. After a crash or a blocked event loop, the next call on that executor starts a fresh process. Calls without 'executor' run in the executor named 'default', which always exists and is the same as passing 'executor: "default"'. In the default executor, 'page' is bound to an active tab reported by Chrome. In single-window sessions, this is the foreground tab. When multiple browser windows are open, Chrome reports one active tab per window and the selected window is unspecified. 'context' is the BrowserContext that owns the selected page. Use 'browser.contexts()' to select a context or page explicitly. Pass any other name to run the call in a named executor. The first call with a new name creates it. Each named executor owns a tab: its first call opens a new background tab in the default browser context, and 'page' is bound to that tab on every later call while it stays open. Opening it does not change the active tab of an existing window. If the tab is closed, the next call opens a new one and reports 'tab.created: true'. Executor code can still reach other tabs through 'context' and 'browser'; ownership only decides what 'page' is bound to. Use named executors to drive several tabs of one browser in parallel. A browser can have at most 8 named executors; the default executor does not count. A call that would create another returns 409 with the current executors; delete one with DELETE /browsers/{id_or_name}/playwright/executors/{name}. Named executors are not removed automatically while the browser runs; when it shuts down, they are removed and their tabs closed.

POST

browsers

{id_or_name}

playwright

execute

Execute Playwright/TypeScript code against the browser

curl --request POST \
  --url https://api.onkernel.com/browsers/{id_or_name}/playwright/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "executor": "checkout",
  "timeout_sec": 60
}
'

import requests

url = "https://api.onkernel.com/browsers/{id_or_name}/playwright/execute"

payload = {
    "code": "<string>",
    "executor": "checkout",
    "timeout_sec": 60
}
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({code: '<string>', executor: 'checkout', timeout_sec: 60})
};

fetch('https://api.onkernel.com/browsers/{id_or_name}/playwright/execute', 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/{id_or_name}/playwright/execute",
  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([
    'code' => '<string>',
    'executor' => 'checkout',
    'timeout_sec' => 60
  ]),
  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/{id_or_name}/playwright/execute"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"executor\": \"checkout\",\n  \"timeout_sec\": 60\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/{id_or_name}/playwright/execute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"executor\": \"checkout\",\n  \"timeout_sec\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/browsers/{id_or_name}/playwright/execute")

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  \"code\": \"<string>\",\n  \"executor\": \"checkout\",\n  \"timeout_sec\": 60\n}"

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

{
  "success": true,
  "error": "<string>",
  "result": "<unknown>",
  "stderr": "<string>",
  "stdout": "<string>",
  "tab": {
    "created": true,
    "target_id": "<string>"
  }
}

{
  "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"
  }
}

{
  "executors": [
    {
      "busy": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "name": "checkout",
      "target_id": "<string>",
      "url": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "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": "invalid_request",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Makes retrying the call safe. A call with a key already used on this browser returns the first call's response instead of running the code again, waiting for it if it is still running. A call with a key keeps running for 10 seconds after its last caller disconnects, so a retry can collect its response; after that it is cancelled like a call without a key. A response is kept for 10 minutes once the call finishes, and only the most recent responses are kept. A call rejected before the code runs, such as with 400, 409 or 429, does not use up its key. The Kernel SDKs send a key automatically and reuse it when they retry.

Required string length: 1 - 255

Path Parameters

id_or_name

string

required

Browser session ID or name

Body

application/json

Request to execute Playwright code

code

string

required

TypeScript/JavaScript code to execute. The code has access to 'page', 'context', and 'browser' variables. It runs within a function, so you can use a return statement at the end to return a value. This value is returned as the result property in the response. Example: "await page.goto('https://example.com'); return await page.title();"

executor

string

Name of a Playwright executor. Calls with the same name run in the same executor, one at a time; the first call with a new name creates it. Calls on different executors run concurrently. 'default' names the executor that runs calls without a name.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Example:

"checkout"

timeout_sec

integer

default:60

Maximum execution time in seconds. Default is 60.

Required range: 1 <= x <= 300

Response

Code executed successfully

Result of Playwright code execution

success

boolean

required

Whether the code executed successfully

error

string

Error message if execution failed

result

any

The value returned by the code (if any)

stderr

string

Standard error from the execution

stdout

string

Standard output from the execution

tab

object

The tab 'page' was bound to for this call. Absent if the call failed before binding a tab.

Show child attributes

Apps

Audit Logs

Managed Auth

Authentication

Browser Pools

Browsers

Browser Computer Controls

Browser Filesystem

Browser Logs

Browser Playwright

Browser Processes

Browser REPL

Browser Replays

Browser Telemetry

Browser WebMCP

Config Registry

Deployments

Extensions

Invocations

API Keys

Organization

Projects

Profiles

Proxies

Vaults

Execute Playwright/TypeScript code against the browser

Authorizations

Headers

Path Parameters

Body

Response