Skip to content
Sandbox Agent
GitHub Get Started
HTTP API

Create a long-lived managed process.

POST
/v1/processes

Spawns a new process with the given command and arguments. Supports both pipe-based and PTY (tty) modes. Returns the process descriptor on success.

Request Body required

Section titled “Request Body required ”
object
args
Array<string>
command
required
string
cwd
string
nullable
env
object
key
additional properties
string
interactive
boolean
tty
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Started process

object
args
required
Array<string>
command
required
string
createdAtMs
required
integer format: int64
cwd
string
nullable
exitCode
integer format: int32
nullable
exitedAtMs
integer format: int64
nullable
id
required
string
interactive
required
boolean
owner
required
string
Allowed values: user desktop system
pid
integer format: int32
nullable
status
required
string
Allowed values: running exited
tty
required
boolean

400

Section titled “400 ”

Invalid request

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties

409

Section titled “409 ”

Process limit or state conflict

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties

501

Section titled “501 ”

Process API unsupported on this platform

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties