Stream an agent computer terminal

Part of Devices, 10 operations. The overview covers keys, scopes and errors.

GET /v1/devices/{device_id}/terminals/{terminal_id}/stream

Server-sent events, every frame event: terminal with an AgentTerminalFrame as JSON: output (seq strictly increasing), then exit or gone, after which the stream closes. Resume with since=<seq> (or Last-Event-ID). Open a terminal with a bash job {command: <login shell>, runInBackground: true, interactive: true} (a real tty: prompts, sudo and TUIs work) and type into it with bash_write.

A caller key holding devices:read (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session.

Operation id streamAgentTerminal in Devices.

Path parameters

device_id string required
An agent computer (agt_…) on your account.
terminal_id string required
The terminal id a background bash job answered.

Query parameters

since string optional
Resume after this output seq (a byte cursor). Absent: from the start of the buffer.

Response 200

The terminal stream.

text/event-stream: string.

Errors

Status	Code	What to change
400	`invalid_request`	A parameter or body field is invalid; `param` names it and `issues` lists every problem.
401	`unauthorized`	Send a live caller key or session as `Authorization: Bearer …` or `x-api-key`. No key yet: create one at /account/api, or sign a user in at /auth.md.
403	`insufficient_scope`	The key lacks the scope in `required_scopes`; mint a key that holds it.
404	`not_found`	No such resource on this account; check the id.

view .md openapi

Request

curl

curl -sS -X GET "https://superbot.gg/v1/devices/$DEVICE_ID/terminals/$TERMINAL_ID/stream" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"

JavaScript

const deviceId = 'DEVICE_ID';
const terminalId = 'TERMINAL_ID';
const res = await fetch(`https://superbot.gg/v1/devices/${deviceId}/terminals/${terminalId}/stream`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os
import requests

device_id = "DEVICE_ID"
terminal_id = "TERMINAL_ID"
res = requests.request(
    "GET",
    f"https://superbot.gg/v1/devices/{device_id}/terminals/{terminal_id}/stream",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())

Response

200 The terminal stream.

text/event-stream: string

400 The request is malformed or a parameter is invalid; `param` names the field.

{
  "error": "invalid_request",
  "message": "A parameter or body field is invalid; param names it and issues lists every problem.",
  "doc_url": "https://superbot.gg/developers#errors-invalid_request",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

401 The bearer is missing, malformed or unknown.

{
  "error": "unauthorized",
  "message": "Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.",
  "doc_url": "https://superbot.gg/developers#errors-unauthorized",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

403 The key lacks a scope (insufficient_scope), is revoked, or may not call this route.

{
  "error": "insufficient_scope",
  "message": "The key lacks the scope in required_scopes; mint a key that holds it.",
  "doc_url": "https://superbot.gg/developers#errors-insufficient_scope",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

404 No such resource on this account.

{
  "error": "not_found",
  "message": "No such resource on this account; check the id.",
  "doc_url": "https://superbot.gg/developers#errors-not_found",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}