HTTP API
Open an interactive WebSocket terminal session.
GET /v1/processes/{id}/terminal/ws
GET
/v1/processes/{id}/terminal/ws
Upgrades the connection to a WebSocket for bidirectional PTY I/O. Accepts
access_token query param for browser-based auth (WebSocket API cannot
send custom headers). Streams raw PTY output as binary frames and accepts
JSON control frames for input, resize, and close.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Process ID
Query Parameters
Section titled “Query Parameters ” access_token
string
Bearer token alternative for WS auth
Responses
Section titled “ Responses ”WebSocket upgraded
Invalid websocket frame or upgrade request
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties
Unknown process
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties
Not a terminal process
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties
Process API unsupported on this platform
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties