Skip to content
Sandbox Agent
GitHub Get Started
HTTP API

Run a one-shot command.

POST
/v1/processes/run

Executes a command to completion and returns its stdout, stderr, exit code, and duration. Supports configurable timeout and output size limits.

Request Body required

Section titled “Request Body required ”
object
args
Array<string>
command
required
string
cwd
string
nullable
env
object
key
additional properties
string
maxOutputBytes
integer
nullable
timeoutMs
integer format: int64
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”

One-off command result

object
durationMs
required
integer format: int64
exitCode
integer format: int32
nullable
stderr
required
string
stderrTruncated
required
boolean
stdout
required
string
stdoutTruncated
required
boolean
timedOut
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

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