Execute a command asynchronously

POST /browsers/{id}/process/spawn

JavaScript

JavaScript

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);

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)

package main

import (
	"context"
	"fmt"

	"github.com/kernel/kernel-go-sdk"
	"github.com/kernel/kernel-go-sdk/option"
)

func main() {
	client := kernel.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Browsers.Process.Spawn(
		context.TODO(),
		"id",
		kernel.BrowserProcessSpawnParams{
			Command: "command",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Pid)
}

curl --request POST \
  --url https://api.onkernel.com/browsers/{id}/process/spawn \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "args": [],
  "cwd": "<string>",
  "env": {},
  "as_user": "<string>",
  "as_root": false,
  "timeout_sec": 123,
  "allocate_tty": false,
  "rows": 32768,
  "cols": 32768
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/browsers/{id}/process/spawn",
  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([
    'command' => '<string>',
    'args' => [
        
    ],
    'cwd' => '<string>',
    'env' => [
        
    ],
    'as_user' => '<string>',
    'as_root' => false,
    'timeout_sec' => 123,
    'allocate_tty' => false,
    'rows' => 32768,
    'cols' => 32768
  ]),
  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;
}

HttpResponse<String> response = Unirest.post("https://api.onkernel.com/browsers/{id}/process/spawn")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"args\": [],\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"as_user\": \"<string>\",\n  \"as_root\": false,\n  \"timeout_sec\": 123,\n  \"allocate_tty\": false,\n  \"rows\": 32768,\n  \"cols\": 32768\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/browsers/{id}/process/spawn")

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  \"command\": \"<string>\",\n  \"args\": [],\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"as_user\": \"<string>\",\n  \"as_root\": false,\n  \"timeout_sec\": 123,\n  \"allocate_tty\": false,\n  \"rows\": 32768,\n  \"cols\": 32768\n}"

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

200

{
  "process_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pid": 123,
  "started_at": "2023-11-07T05:31:56Z"
}

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

Path Parameters

id · string · required

Browser session ID

Body

application/json

Request to execute a command synchronously.

command · string · required

Executable or shell command to run.

args · string[]

Command arguments.

cwd · string | null

Working directory (absolute path) to run the command in.

Pattern: ^/.*

env · object

Environment variables to set for the process.

Show child attributes

as_user · string | null

Run the process as this user.

as_root · boolean · default: false

Run the process with root privileges.

timeout_sec · integer | null

Maximum execution time in seconds.

allocate_tty · boolean · default: false

Allocate a pseudo-terminal (PTY) for interactive shells.

rows · integer

Initial terminal rows. Only used when allocate_tty is true.

Required range: 1 <= x <= 65535

cols · integer

Initial terminal columns. Only used when allocate_tty is true.

Required range: 1 <= x <= 65535

Response

200

application/json

Spawned

Information about a spawned process.

process_id · string<uuid>

Server-assigned identifier for the process.

pid · integer

OS process ID.

started_at · string<date-time>

Timestamp when the process started.