Skip to navigation

Open a terminal on your dev session's sandbox

View as Markdown
Opens an interactive shell in a sandbox that your own dev session for the agent holds. The protocol matches the deployment terminal. A request with no Origin header is refused, so send the server's own URL as Origin.

Handshake

WSS
wss://astropods.com/api/v1/accounts/:account/dev-sessions/:agent/sandboxes/:name/terminal

Send

sendOpenATerminalOnYourDevSessionsSandboxstringRequiredformat: "binary"

Keystrokes and pasted text for the shell, as a binary frame of UTF-8 bytes.

OR
sendOpenATerminalOnYourDevSessionsSandboxobjectRequired
The terminal's size in characters, as a text frame. Send it on open and whenever the size changes.

Receive

receiveOpenATerminalOnYourDevSessionsSandboxstringRequiredformat: "binary"
Shell output, as a binary frame of raw terminal bytes including escape sequences.