Control API

WebSocket Endpoints — Some endpoints in this section use WebSocket for bidirectional communication. The SDK handles the connection protocol automatically.

Control Channel

WSS/v1/sprites/{name}/control

Multiplexed control channel for sequential operations (exec, proxy) over a single persistent WebSocket connection. Reduces connection overhead for clients sending many operations.

Query Parameters

op:optionalstring

Auto-start operation on connect (exec, proxy)

Responses

Status	Description
101	Switching Protocols - WebSocket connection established
400	Bad Request - Invalid WebSocket upgrade or missing parameters
404	Not Found - Resource not found

Request

HTTP

websocat \
"wss://api.sprites.dev/v1/sprites/{name}/control" \
-H "Authorization: Bearer $SPRITES_TOKEN"

---

Control WebSocket

WSS/v1/sprites/{name}/control

Persistent WebSocket connection that multiplexes sequential operations (exec, proxy) over a single connection using the control envelope protocol.

Responses

Status	Description
101	Switching Protocols - WebSocket connection established
400	Bad Request - Invalid WebSocket upgrade or missing parameters
404	Not Found - Resource not found

Request

HTTP

websocat \
"wss://api.sprites.dev/v1/sprites/{name}/control" \
-H "Authorization: Bearer $SPRITES_TOKEN"

---