Shell terminal WebSocket

GET

/api/v1/projects/{projectId}/{agentType}/ws/{wid}/shell

• Local development server

Upgrades to a WebSocket and bridges it to the worktree’s auxiliary bash-shell tmux session (backing the “Terminal” tab in the webapp). The session is lazily created on first connect and persists for the lifetime of the worktree. Binary frames carry raw PTY data; text frames carry JSON control messages (e.g. {“type”:“resize”,“cols”:80,“rows”:24}).

Parameters

Path Parameters

projectId

required

string

Project ID

agentType

required

string

Agent type

wid

required

string

Worktree ID

Responses

101

WebSocket upgrade

400

Bad Request

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN CONTAINER_EXISTS NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string

404

Not Found

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN CONTAINER_EXISTS NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string

500

Internal Server Error

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN CONTAINER_EXISTS NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string

503

Terminal proxy not configured

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN CONTAINER_EXISTS NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string