Skip to main content
POST
cURL

Path Parameters

id
string
required

Body

application/json
shell
enum<string>

Shell to use for the terminal session

Available options:
bash,
zsh,
fish,
sh
Example:

"bash"

cwd
string

Working directory for the terminal session

Example:

"/app"

cols
integer

Terminal width in columns

Required range: x > 0
Example:

80

rows
integer

Terminal height in rows

Required range: x > 0
Example:

24

Response

Terminal created

terminal
object
required
wsUrl
string
required

WebSocket URL for connecting to the terminal

Example:

"wss://api.simplesandbox.dev/api/v1/sandboxes/e7847229c547d8/terminals/1234/ws"