Create PTY session
POST /v1/sandbox/{sandboxID}/pty
POST
/v1/sandbox/{sandboxID}/pty
Create a new interactive terminal session. A shell process is spawned inside the sandbox.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” sandboxID
required
string
Unique sandbox identifier.
Request Body required
Section titled “Request Body required ”object
id
Optional session ID. Auto-generated if not provided.
string
Example
my-terminal cwd
Starting directory.
string
Example
/home/user envs
Environment variables.
object
key
additional properties
string
Example
{ "TERM": "xterm-256color"} cols
Terminal columns.
integer
Example
120 rows
Terminal rows.
integer
Example
40 lazy_start
Defer shell process start until first WebSocket connection.
boolean
Responses
Section titled “ Responses ”PTY session created.
object
id
required
string
Example
my-terminal cwd
required
string
Example
/home/user envs
required
object
key
additional properties
string
cols
required
integer
Example
120 rows
required
integer
Example
40 created_at
required
string format: date-time
active
required
boolean
lazy_start
required
boolean
Bad request – validation error.
object
message
required
Summary message, e.g. “Invalid request”.
string
errors
required
Array<object>
object
field
required
JSON field name that failed validation (e.g. “path”, “command”).
string
error
required
Human-readable description of the validation failure.
string
Unauthorized – invalid or missing API key.
object
message
required
Human-readable error message.
string