Skip to main content
POST /v1/agents/runtime/{runtime_id}/pty Allocates a pseudo-terminal in the runtime and launches a shell on it. Every argument is optional; omitted values use the execution plane defaults (/bin/bash in /workspace at 80x24). The session keeps running after this call returns and after the client disconnects.

Parameters

Response

Returns a PtySession.

Notes

  • Set cols and rows to match the surface you will render the output on. Programs that format for the terminal width read them at start up, so getting the geometry right at creation time avoids a reflow.
  • A runtime allows 8 concurrent sessions. If you create sessions per task, kill them when the task finishes.
  • Setting TERM to xterm-256color enables colour output from most tools. Leave it unset if you would rather parse plain text without escape sequences.