Appearance
Fresh 🌱
Execute a command asynchronously ​
OpenAPI ​
yaml
openapi: 3.1.0
info:
title: Kernel API
description: Developer tools and cloud infrastructure for AI agents to use web browsers
version: 0.1.0
servers:
- url: https://api.onkernel.com
description: API Server
security:
- bearerAuth: []
tags:
- name: Browsers
description: Create and manage browser sessions.
- name: Browser Replays
description: Record and manage browser session video replays.
- name: Profiles
description: Create, list, retrieve, and delete browser profiles.
- name: Browser Filesystem
description: Read, write, and manage files on the browser instance.
- name: Browser Computer Controls
description: Control mouse, keyboard, and screen on the browser instance.
- name: Browser Playwright
description: Execute Playwright code against the browser instance.
- name: Browser Processes
description: Execute and manage processes on the browser instance.
- name: Browser Logs
description: Stream logs from the browser instance.
- name: Extensions
description: Create, list, retrieve, and delete browser extensions.
- name: Proxies
description: Create and manage proxy configurations for routing browser traffic.
- name: Browser Pools
description: Create and manage browser pools for acquiring and releasing browsers.
- name: Managed Auth
description: >-
Create and manage auth connections for automated credential capture and
login.
- name: Credentials
description: Create and manage credentials for authentication.
- name: Credential Providers
description: Configure external credential providers like 1Password.
- name: Apps
description: List applications and versions.
- name: Deployments
description: Create and manage app deployments and stream deployment events.
- name: Invocations
description: Invoke actions and stream or query invocation status and events.
- name: Projects
description: Create and manage projects for resource isolation within an organization.
paths:
/browsers/{id}/process/spawn:
post:
tags:
- Browser Processes
summary: Execute a command asynchronously
operationId: processSpawn
parameters:
- name: id
in: path
required: true
description: Browser session ID
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSpawnRequest'
responses:
'200':
description: Spawned
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSpawnResult'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
security:
- bearerAuth: []
x-codeSamples:
- lang: JavaScript
source: >-
import Kernel from '@onkernel/sdk';
const client = new Kernel({
apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});
const response = await client.browsers.process.spawn('id', {
command: 'command' });
console.log(response.pid);
- lang: Python
source: |-
import os
from kernel import Kernel
client = Kernel(
api_key=os.environ.get("KERNEL_API_KEY"), # This is the default and can be omitted
)
response = client.browsers.process.spawn(
id="id",
command="command",
)
print(response.pid)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/kernel/kernel-go-sdk\"\n\t\"github.com/kernel/kernel-go-sdk/option\"\n)\n\nfunc main() {\n\tclient := kernel.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Browsers.Process.Spawn(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t\tkernel.BrowserProcessSpawnParams{\n\t\t\tCommand: \"command\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Pid)\n}\n"
components:
schemas:
ProcessSpawnRequest:
allOf:
- $ref: '#/components/schemas/ProcessExecRequest'
- type: object
properties:
allocate_tty:
type: boolean
description: Allocate a pseudo-terminal (PTY) for interactive shells.
default: false
rows:
type: integer
description: Initial terminal rows. Only used when allocate_tty is true.
minimum: 1
maximum: 65535
cols:
type: integer
description: Initial terminal columns. Only used when allocate_tty is true.
minimum: 1
maximum: 65535
ProcessSpawnResult:
type: object
description: Information about a spawned process.
properties:
process_id:
type: string
format: uuid
description: Server-assigned identifier for the process.
pid:
type: integer
description: OS process ID.
started_at:
type: string
format: date-time
description: Timestamp when the process started.
additionalProperties: false
ProcessExecRequest:
type: object
description: Request to execute a command synchronously.
required:
- command
properties:
command:
type: string
description: Executable or shell command to run.
args:
type: array
description: Command arguments.
items:
type: string
default: []
cwd:
type: string
description: Working directory (absolute path) to run the command in.
nullable: true
pattern: ^/.*
env:
type: object
description: Environment variables to set for the process.
additionalProperties:
type: string
default: {}
as_user:
type: string
description: Run the process as this user.
nullable: true
as_root:
type: boolean
description: Run the process with root privileges.
default: false
timeout_sec:
type: integer
description: Maximum execution time in seconds.
nullable: true
additionalProperties: false
Error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Application-specific error code (machine-readable)
example: bad_request
message:
type: string
description: Human-readable error description for debugging
example: 'Missing required field: app_name'
details:
type: array
description: Additional error details (for multiple errors)
items:
$ref: '#/components/schemas/ErrorDetail'
inner_error:
$ref: '#/components/schemas/ErrorDetail'
ErrorDetail:
type: object
properties:
code:
type: string
description: Lower-level error code providing more specific detail
example: invalid_input
message:
type: string
description: Further detail about the error
example: Provided version string is not semver compliant
responses:
BadRequest:
description: Bad Request - invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer