Skip to main content
Desktop APIs require a desktop-capable template. PTY sessions are available for interactive terminal workflows in running machines. Idle PTY streams remain connected while the machine is running. A WebSocket close without a pty_exited message is surfaced as a transport disconnect.

Desktop

Managed viewer

Input, windows, and recordings

PTY

PTY sessions expose a string session_id for reconnect and management helpers. id is an alias for session_id. Numeric pid reconnect remains available for legacy scripts.
Manage existing PTY sessions by session_id:
Concept: Create. API reference: screenshot, startDesktopStream, websocketUpgrade, listPtySessions, and killPtySession.