Skip to main content
New to Corsair? See API access, authentication, and error handling.

Api Keys

create

apiKeys.create Create a Kernel API key. The secret is shown once in the response: store it right away and never paste it into chat. Risk: destructive
Input
Output

delete

apiKeys.delete Delete an API key; anything using it stops working. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

apiKeys.get Get an API key’s metadata. Risk: read
Input Output

list

apiKeys.list List API keys (names, scopes, last used; never the secrets). Risk: read
Input Output

rotate

apiKeys.rotate Replace an API key’s secret. The new secret is shown once. The old one keeps working for expire_in_days (7 by default); pass expire_in_days: 0 to end it now. Risk: destructive · Irreversible
Input Output

update

apiKeys.update Rename an API key or change its settings. Risk: write
Input
Output

Apps

list

apps.list List deployed Kernel apps and their versions and actions. Risk: read
Input Output

Audit Logs

exportChunk

auditLogs.exportChunk Download one chunk of the audit log as JSONL (gzipped by default). Returns a file plus has_more and next_cursor for the next chunk. Risk: read
Input Output

exportDestinations.create

auditLogs.exportDestinations.create Add a destination (such as an S3 bucket) that receives continuous audit log exports. Risk: write
Input Output

exportDestinations.delete

auditLogs.exportDestinations.delete Delete an audit log export destination. Cannot be undone. Risk: destructive · Irreversible
Input Output

exportDestinations.get

auditLogs.exportDestinations.get Get an audit log export destination. Risk: read
Input Output

exportDestinations.list

auditLogs.exportDestinations.list List audit log export destinations. Risk: read
Input Output

exportDestinations.test

auditLogs.exportDestinations.test Send a test export to an audit log destination to check it works. Risk: write
Input Output

exportDestinations.update

auditLogs.exportDestinations.update Update an audit log export destination. Risk: write
Input Output

list

auditLogs.list Search the org’s audit log (who called what, when), newest first. Pages with page_token; check has_more. Risk: read
Input Output

Auth

connections.create

auth.connections.create Set up managed login for a site: one connection per profile and domain (the profile is created if missing). Then start a login with auth.connections.login. Risk: write
Input
Output

connections.delete

auth.connections.delete Delete a managed auth connection and stop its health checks and logins. Cannot be undone; the profile stays. Risk: destructive · Irreversible
Input Output

connections.exchange

auth.connections.exchange Exchange a login handoff code for a short-lived token, as Kernel’s hosted login page does. Risk: write
Input Output

connections.get

auth.connections.get Get a managed auth connection and its current login flow: status, step, the fields it is waiting for, and hosted_url or live_view_url for a person to finish it. Poll this while a login runs. Risk: read
Input Output

connections.list

auth.connections.list List managed auth connections (site logins Kernel keeps signed in), filtered by profile or domain. Risk: read
Input Output

connections.login

auth.connections.login Start a login for a managed auth connection. Returns hosted_url (and live_view_url) for a person to complete it, or logs in by itself when credentials are stored. Then poll auth.connections.get, and send asked-for fields with auth.connections.submit. Risk: write
Input
Output

connections.submit

auth.connections.submit Send the values a running login asks for (a username, password, one-time code, or a choice) to a managed auth connection. Poll auth.connections.get for the result. Risk: write
Input Output

connections.timeline

auth.connections.timeline List a managed auth connection’s history (logins, re-auths, health checks), newest first. Risk: read
Input Output

connections.update

auth.connections.update Change a managed auth connection’s settings: health checks, auto re-auth, credential, proxy, login URL. Risk: write
Input
Output

context.get

auth.context.get Show who the API key is: its organization, project and scopes. Risk: read
Input: empty object Output

Browser Pools

acquire

browserPools.acquire Take a ready browser from a pool (waits up to acquire_timeout_seconds). Returns null when none freed up in time; call again. Give it back with browserPools.release. Risk: write
Input
Output

create

browserPools.create Create a pool of pre-started browsers with one configuration, for instant browserPools.acquire. Idle pool browsers are not billed but count toward the concurrency limit. Risk: write
Input
Output

delete

browserPools.delete Delete a browser pool and its browsers. Cannot be undone. Risk: destructive · Irreversible
Input Output

flush

browserPools.flush Delete a pool’s idle browsers so it refills with fresh ones. Risk: write
Input Output

get

browserPools.get Get a browser pool: configuration, size, and how many browsers are available or leased. Risk: read
Input Output

list

browserPools.list List browser pools and their sizes. Risk: read
Input Output

release

browserPools.release Return an acquired browser to its pool (optionally reusing it rather than replacing it). Risk: write
Input Output

update

browserPools.update Change a browser pool’s size or browser configuration. A change applies to browsers the pool creates afterwards: pass discard_all_idle: true to rebuild idle ones now, and release leased ones with reuse: false. To stop loading a profile, send profile: { id: "" }; browsers already in the pool keep the old profile until rebuilt. Risk: write
Input
Output

Browsers

computer.batch

browsers.computer.batch Run a list of computer actions (click_mouse, type_text, press_key, scroll, move_mouse, drag_mouse, sleep and more) in order in one call; stops at the first error. Faster than one call per action. Risk: write
Input
Output

computer.captureScreenshot

browsers.computer.captureScreenshot Take a PNG screenshot of the browser screen (optionally a region). Headful browsers only: a headless browser has no window, so this returns an empty screen; there, use page.screenshot() inside browsers.playwright.execute. Returns a file: on Corsair it is saved to Files and comes back with a fileId. Risk: read
Input
Output

computer.clickMouse

browsers.computer.clickMouse Click at screen coordinates x, y (left, right or middle button; num_clicks for double-click). Risk: write
Input Output

computer.dragMouse

browsers.computer.dragMouse Press the mouse, drag it along a path of [x, y] points, and release. Risk: write
Input Output

computer.getMousePosition

browsers.computer.getMousePosition Get the mouse cursor’s current screen coordinates. Risk: read
Input Output

computer.moveMouse

browsers.computer.moveMouse Move the mouse cursor to screen coordinates x, y (hover). Risk: write
Input Output

computer.pressKey

browsers.computer.pressKey Press keys or a combination on the browser’s keyboard, e.g. [“Return”] or [“Ctrl+a”] (X keysym names). Risk: write
Input Output

computer.readClipboard

browsers.computer.readClipboard Read the text on the browser VM’s clipboard. Risk: read
Input Output

computer.scroll

browsers.computer.scroll Scroll the mouse wheel by delta_x/delta_y at screen coordinates x, y. Risk: write
Input Output

computer.setCursorVisibility

browsers.computer.setCursorVisibility Show or hide the mouse cursor in screenshots and live view. Risk: write
Input Output

computer.typeText

browsers.computer.typeText Type text into the focused field, as keystrokes (optional delay between keys). Risk: write
Input Output

computer.writeClipboard

browsers.computer.writeClipboard Put text on the browser VM’s clipboard. Risk: write
Input Output

create

browsers.create Start a cloud Chromium browser and get its session_id, cdp_ws_url and browser_live_view_url. Use headless: true unless a person must watch or take over: headless costs about 8x less ($0.06/h vs $0.48/h) and has no live view. stealth: true (or captcha_solver + proxy) helps on bot-protected sites. Pass profile {name, save_changes: true} to start signed in and keep new cookies; the profile is saved when the browser is deleted. start_url opens a page. A browser bills per second while it is active (a CDP, live view or computer-control connection), drops to unbilled standby after about 10 s idle, and is deleted after timeout_seconds of standby (default 60). It holds one of the org’s concurrent-browser slots until deleted, so call browsers.delete when done. Risk: write
Input
Output

curl

browsers.curl Send an HTTP request from inside the browser (its cookies, proxy and network fingerprint) and get status, headers and body back. Handy for an API call that needs the signed-in session. Risk: write
Input Output

delete

browsers.delete End a browser session now and stop its billing; frees its concurrency slot. If it was started with profile save_changes: true, the cookies and storage are saved to the profile first. Cannot be undone: the session, its tabs and its files are gone. Risk: write
Input Output

fs.createDirectory

browsers.fs.createDirectory Create a directory (and its parents) in the browser VM. Risk: write
Input Output

fs.deleteDirectory

browsers.fs.deleteDirectory Delete a directory and everything in it from the browser VM. Risk: destructive · Irreversible
Input Output

fs.deleteFile

browsers.fs.deleteFile Delete a file from the browser VM. Risk: destructive · Irreversible
Input Output

fs.downloadDirZip

browsers.fs.downloadDirZip Download a directory from the browser VM as a zip. Returns a file: on Corsair it is saved to Files and comes back with a fileId. Risk: read
Input Output

fs.fileInfo

browsers.fs.fileInfo Get a file’s or directory’s size, mode and modified time in the browser VM. Risk: read
Input Output

fs.listFiles

browsers.fs.listFiles List the files and folders in a directory of the browser VM, with sizes and times. Risk: read
Input Output: object[]

fs.move

browsers.fs.move Move or rename a file or directory in the browser VM. Risk: write
Input Output

fs.readFile

browsers.fs.readFile Read a file from the browser VM (for example a download in /tmp/downloads). Returns a file: on Corsair it is saved to Files and comes back with a fileId. Risk: read
Input Output

fs.setFilePermissions

browsers.fs.setFilePermissions Change a file’s mode or owner in the browser VM. Risk: write
Input Output

fs.upload

browsers.fs.upload Upload one or more files into the browser VM, each {file, dest_path}; a file is a public URL, {url} or {base64}. Risk: write
Input
Output

fs.uploadZip

browsers.fs.uploadZip Upload a zip archive and unpack it into dest_path in the browser VM. Risk: write
Input
Output

fs.watch.start

browsers.fs.watch.start Start watching a directory in the browser VM for changes; returns a watch_id. Kernel streams the events (not available here), so poll browsers.fs.listFiles instead when you can. Risk: write
Input Output

fs.watch.stop

browsers.fs.watch.stop Stop a directory watch by its watch_id. Risk: write
Input Output

fs.writeFile

browsers.fs.writeFile Write a file into the browser VM at path (creates or replaces it). Pass the contents as a URL or {base64}. Risk: write
Input
Output

get

browsers.get Get a browser session: status, URLs (cdp_ws_url, browser_live_view_url), profile, proxy, timeout and usage cost so far. Risk: read
Input Output

list

browsers.list List browser sessions in the project, newest first; filter by status (active, deleted, all), tags or name query. Pages with offset/limit; check has_more. Risk: read
Input Output

liveView.create

browsers.liveView.create Make a live view link for a headful browser so a person can watch (scope read) or take over (scope control): log in, solve a captcha, approve a step. The link lasts until the browser is deleted or ttl_seconds passes and cannot be revoked, so treat it as a credential and share it only with the person who needs it. Headless browsers have no live view. Risk: write
Input Output

loadExtensions

browsers.loadExtensions Load unpacked Chrome extensions (each a zip, as a URL or base64) into a running browser. Risk: write
Input
Output

playwright.execute

browsers.playwright.execute The simplest way to act on a page: run Playwright code in the browser’s VM in one call and get its return value as result (plus stdout/stderr and error). The code gets page, context, browser and webmcp, e.g. await page.goto('https://example.com'); return await page.title();. timeout_sec defaults to 60 (max 300). Calls with the same executor name run one at a time in a shared process; pass idempotency_key to make a retry safe. Risk: write
Input Output

playwright.executors.delete

browsers.playwright.executors.delete Stop and remove a named Playwright executor on a browser; a later call with that name starts a fresh one. Risk: destructive · Irreversible
Input Output

playwright.executors.list

browsers.playwright.executors.list List the Playwright executors (worker processes) on a browser and whether each is busy. Risk: read
Input Output

process.exec

browsers.process.exec Run a shell command in the browser VM and wait for it: returns exit code, stdout and stderr (base64). Set timeout_sec for long commands. Risk: write
Input Output

process.kill

browsers.process.kill Send a signal to a spawned process. signal is required: TERM to end it, KILL to force it, or INT, HUP. Risk: write
Input Output

process.resize

browsers.process.resize Resize the terminal of a process spawned with allocate_tty. Risk: write
Input Output

process.spawn

browsers.process.spawn Start a command in the browser VM without waiting; returns a process_id for browsers.process.status, stdin and kill. Risk: write
Input Output

process.status

browsers.process.status Get a spawned process’s state, exit code and resource use. Risk: read
Input Output

process.stdin

browsers.process.stdin Write data (base64) to a spawned process’s stdin. Risk: write
Input Output

repl

browsers.repl Run JavaScript in a persistent Node.js REPL inside the browser VM; variables persist between calls (reset: true starts fresh). Start with repl.help(). Output comes from repl.write, console or repl.emitImage. Risk: write
Input Output

replays.download

browsers.replays.download Download a replay recording as MP4. Returns a file: on Corsair it is saved to Files and comes back with a fileId. Errors with “still preparing” for a few seconds after the recording stops. Risk: read
Input Output

replays.list

browsers.replays.list List a browser’s replay recordings with their ids and view URLs. Risk: read
Input Output: object[]

replays.start

browsers.replays.start Start recording the browser screen as a video replay (headful browsers); returns a replay_id. Risk: write
Input Output

replays.stop

browsers.replays.stop Stop a replay recording; download it with browsers.replays.download once it is processed. Risk: write
Input Output

saveProfile

browsers.saveProfile Save the running browser’s cookies and storage to a profile now, without ending the session: by id (overwrite) or by name (overwrite or create). Risk: write
Input Output

telemetry.events

browsers.telemetry.events Read a page of telemetry events for a browser (console, network, page, interaction, captcha and more), filtered by category, type and time. Pages with offset; check has_more. Risk: read
Input Output

update

browsers.update Change a running browser: rename it, change its proxy, viewport or tags, or attach a profile it was started without. Risk: write
Input
Output

webmcp.customTools.add

browsers.webmcp.customTools.add Register custom WebMCP tools (JavaScript run in a page) on a browser’s tabs. Risk: write
Input Output

webmcp.customTools.list

browsers.webmcp.customTools.list List the custom WebMCP tools registered on a browser. Risk: read
Input Output

webmcp.customTools.remove

browsers.webmcp.customTools.remove Remove a custom WebMCP tool from a browser by its id. Risk: destructive · Irreversible
Input Output

webmcp.invokeTool

browsers.webmcp.invokeTool Call a WebMCP tool a page exposes, by the tool_ref from browsers.webmcp.listTools, with its input. Risk: write
Input
Output

webmcp.listTools

browsers.webmcp.listTools List the WebMCP tools that open pages expose (native and custom), each with a tool_ref to call it with browsers.webmcp.invokeTool. Tools vanish when their page navigates away. Risk: read
Input Output

Config Registry

analyses.cancel

configRegistry.analyses.cancel Cancel a running config analysis. Risk: write
Input Output

analyses.get

configRegistry.analyses.get Get a config analysis and its result. Risk: read
Input Output

analyses.list

configRegistry.analyses.list List config analyses. Risk: read
Input Output

list

configRegistry.list List known site configurations. Risk: read
Input Output

lookup

configRegistry.lookup Look up Kernel’s recommended browser and proxy settings for a bot-protected site (no side effects). Risk: read
Input Output

resolve

configRegistry.resolve Ask Kernel to analyse a site and work out the browser and proxy settings that get through its bot protection; poll configRegistry.analyses.get. Risk: write
Input Output

Credential Providers

create

credentialProviders.create Connect an external credential provider (such as 1Password) so managed auth can read logins from it. Risk: write
Input Output

delete

credentialProviders.delete Disconnect and delete a credential provider. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

credentialProviders.get Get a credential provider. Risk: read
Input Output

list

credentialProviders.list List connected credential providers (such as 1Password). Risk: read
Input Output

listItems

credentialProviders.listItems List the logins a credential provider makes available (no secret values). Risk: read
Input Output

test

credentialProviders.test Check that a credential provider’s connection works. Risk: read
Input Output

update

credentialProviders.update Change a credential provider’s settings or token. Risk: write
Input Output

Credentials

create

credentials.create Store login values (username, password, TOTP secret) for a domain so managed auth can sign in by itself. Values are write-only. Risk: write
Input Output

delete

credentials.delete Delete a stored credential. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

credentials.get Get a stored credential’s metadata (values are never returned). Risk: read
Input Output

list

credentials.list List stored credentials (names and domains; values are never returned). Risk: read
Input Output

totpCode

credentials.totpCode Get the current one-time code for a credential that has a TOTP secret, and when it expires. Risk: read
Input Output

update

credentials.update Change a stored credential’s values or settings. Risk: write
Input Output

Deployments

create

deployments.create Deploy a Kernel app from a zip (URL or base64) with its entrypoint, or from a source repository. Risk: write
Input
Output

delete

deployments.delete Delete an app deployment. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

deployments.get Get a deployment and its status. Poll this instead of the event stream. Risk: read
Input Output

list

deployments.list List app deployments. Risk: read
Input Output

Extensions

delete

extensions.delete Delete an uploaded extension. Cannot be undone. Risk: destructive · Irreversible
Input Output

download

extensions.download Download an uploaded extension’s zip. Returns a file. Risk: read
Input Output

downloadFromChromeStore

extensions.downloadFromChromeStore Download an extension from the Chrome Web Store as an unpacked zip, ready for extensions.upload. Returns a file. Risk: read
Input Output

get

extensions.get Get an uploaded extension’s metadata. Risk: read
Input Output

list

extensions.list List uploaded Chrome extensions. Risk: read
Input Output

upload

extensions.upload Upload a Chrome extension (a zip of the unpacked extension, as a URL or base64) to use in browsers by name. Risk: write
Input
Output

Invocations

create

invocations.create Run an action of a deployed Kernel app (billed per second). async: true returns at once; poll invocations.get for the result. Risk: destructive · Irreversible
Input Output

deleteBrowsers

invocations.deleteBrowsers Delete every browser an invocation started. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

invocations.get Get an invocation: status, output and timing. Poll this instead of the event stream. Risk: read
Input Output

list

invocations.list List app action invocations, filtered by app, action, status or time. Risk: read
Input Output

listBrowsers

invocations.listBrowsers List the browsers an invocation started. Risk: read
Input Output

update

invocations.update Change an invocation’s status, for example mark it succeeded or failed with output. Risk: write
Input Output

Organization

entitlements.get

organization.entitlements.get Get what the org’s plan includes (features and quotas). Risk: read
Input: empty object Output

limits.get

organization.limits.get Get the org’s limits and current use: concurrent browsers, managed auth connections, vaults. Risk: read
Input: empty object Output

limits.update

organization.limits.update Set the default concurrent-browser cap for projects without their own. Risk: write
Input Output

Profiles

create

profiles.create Create an empty browser profile (saved cookies and storage) to start browsers signed in. Fill it by starting a browser with profile {name, save_changes: true}, logging in, then deleting the browser. Risk: write
Input Output

delete

profiles.delete Delete a browser profile and its saved cookies and storage. Cannot be undone. Risk: destructive · Irreversible
Input Output

download

profiles.download Download a profile’s saved state as a tar.zst (or tar) archive. Returns a file. Holds session cookies: treat it as a credential. Risk: read
Input Output

get

profiles.get Get a browser profile by id or name. Risk: read
Input Output

list

profiles.list List saved browser profiles (name, id, last used). Risk: read
Input Output

update

profiles.update Rename a browser profile. Risk: write
Input Output

Projects

create

projects.create Create a project to keep browsers, profiles and keys separate within the org. Risk: write
Input Output

delete

projects.delete Delete a project. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

projects.get Get a project. Risk: read
Input Output

limits.get

projects.limits.get Get a project’s concurrency limit and use. Risk: read
Input Output

limits.update

projects.limits.update Set a project’s concurrent-browser cap. Risk: write
Input Output

list

projects.list List the org’s projects. Risk: read
Input Output

update

projects.update Rename or change a project. Risk: write
Input Output

Proxies

check

proxies.check Check that a proxy works and see its exit IP. Risk: read
Input Output

create

proxies.create Create a proxy configuration (datacenter, ISP, residential, mobile or your own) for browsers to route through. Risk: write
Input
Output

delete

proxies.delete Delete a proxy configuration. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

proxies.get Get a proxy configuration. Risk: read
Input Output

list

proxies.list List proxy configurations. Risk: read
Input Output

update

proxies.update Change a proxy configuration. Risk: write
Input
Output

Proxy IPs

get

proxyIPs.get Get a reserved ISP proxy IP. Risk: read
Input Output

list

proxyIPs.list List the org’s reserved ISP proxy IPs. Risk: read
Input Output

Reports

create

reports.create Submit a typed report against a task (validated against the report type’s schema). Risk: write
Input
Output

get

reports.get Get a report. Risk: read
Input Output

list

reports.list List a task’s reports, oldest first. Risk: read
Input Output

Report Types

get

reportTypes.get Get a report type and its schema. Risk: read
Input Output

list

reportTypes.list List report types. Risk: read
Input Output

versions.get

reportTypes.versions.get Get one version of a report type’s schema. Risk: read
Input Output

contents.fetch

search.contents.fetch Fetch the page contents of chosen results from an earlier search (by result_ids or the top limit results). Risk: read
Input
Output

create

search.create Search the web through one of Kernel’s search providers and get ranked results (titles, URLs, snippets), kept for search.contents.fetch. Risk: read
Input
Output

get

search.get Get a search that was run earlier, with its results. Risk: read
Input Output

providers.list

search.providers.list List the search providers and the options each supports. Risk: read
Input Output: object[]

Tasks

create

tasks.create Record a task an agent is working on, optionally with the browsers it uses; submit reports against it. Risk: write
Input Output

get

tasks.get Get a task. Risk: read
Input Output

linkBrowsers

tasks.linkBrowsers Link browser sessions to a task. Risk: write
Input Output

list

tasks.list List tasks, newest first. Risk: read
Input Output

Telemetry

destinations.create

telemetry.destinations.create Add an OTLP destination that browser sessions export telemetry to. Risk: write
Input Output

destinations.delete

telemetry.destinations.delete Delete an OTLP telemetry destination. Cannot be undone. Risk: destructive · Irreversible
Input Output

destinations.get

telemetry.destinations.get Get an OTLP telemetry destination. Risk: read
Input Output

destinations.list

telemetry.destinations.list List OTLP telemetry destinations. Risk: read
Input Output

destinations.update

telemetry.destinations.update Update an OTLP telemetry destination. Risk: write
Input Output

Vault Provider Configs

create

vaultProviderConfigs.create Register a vault provider configuration (card or payment provider settings shared by the org’s projects). Risk: write
Input: object
Output: object

delete

vaultProviderConfigs.delete Delete an unused vault provider configuration. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

vaultProviderConfigs.get Get a vault provider configuration. Risk: read
Input Output: object

list

vaultProviderConfigs.list List vault provider configurations. Risk: read
Input Output

update

vaultProviderConfigs.update Update a vault provider configuration. Risk: write
Input
Output: object

Vaults

delete

vaults.delete Delete a vault and invalidate every item in it. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

vaults.get Get a vault. Risk: read
Input Output

getEncryptionKey

vaults.getEncryptionKey Get a vault’s public key, for encrypting credential values in a browser before they are sent. Risk: read
Input Output

items.delete

vaults.items.delete Delete a vault item and invalidate its secret. Cannot be undone. Risk: destructive · Irreversible
Input Output

items.events

vaults.items.events List a vault item’s audit events. Risk: read
Input Output: object[]

items.get

vaults.items.get Get a vault item and the operations it currently offers (wait up to 60 s for a change). Risk: read
Input Output: object

items.list

vaults.items.list List a vault’s items (no secret values). Risk: read
Input Output: object[]

items.performOperation

vaults.items.performOperation Run an operation a vault item offers, such as fill, authorize, confirm_transaction or add_payment_method. Some move money or use a card: confirm with the person first. Risk: destructive · Irreversible
Input: object
Output: object

items.update

vaults.items.update Update a vault item’s card specification or credential values. Risk: write
Input: object
Output: object

items.upsert

vaults.items.upsert Create a vault item (card, credential, wallet or payment request) under a key, or get the identical existing one. Risk: write
Input: object
Output: object

list

vaults.list List vaults in the project. Risk: read
Input Output

upsert

vaults.upsert Create a vault (a project-scoped store of secrets, cards and credentials for browsers to use), or get the existing one with that name. Risk: write
Input Output