openTerminal

GET

/api/v1/agents/{agentId}/terminal

WebSocket upgrade to an interactive shell in the sandbox (operator role). A sleeping agent is woken. Binary messages carry terminal input and output. Text messages are JSON: the client sends {"type":"resize","cols":N,"rows":N}; the server sends {"type":"status","message":"..."} while waking, {"type":"exit","code":N} and {"type":"error","message":"..."}.

openTerminal

curl --request GET \
  --url '<base-url>/api/v1/agents/<agentId>/terminal' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>/terminal';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/agents/<agentId>/terminal"

headers = {"cookie": "agenthold_session=<agenthold_session>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Query parameters

cols
optional
integer
rows
optional
integer
auth
optional
string
Run this harness login method (agent admin) instead of a shell.

Returns

101

Switching to WebSocket.

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required