Skip to main content
POST
Open a terminal

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Path Parameters

id
string
required

Stable public computer identifier.

Minimum string length: 1
Example:

"cmp_123"

Body

application/json
request_id
string
required
Pattern: ^cmp_[0-9a-f]{24}\.pty\.[0-9a-f]{32}$
command
string
cols
integer
Required range: 0 <= x <= 65535
rows
integer
Required range: 0 <= x <= 65535

Response

The terminal session and a WebSocket ticket.

id
string
required
pid
integer
required
started_at
string<date-time>
required
cols
integer
required
Required range: x >= 0
rows
integer
required
Required range: x >= 0
ticket
string
required
expires_at
string<date-time>
required
ws_url
string
required