Skip to content
Hoody Documentation
Hoody.com

Hoody Terminal

Section titled “Hoody Terminal”

The Hoody Terminal service provides programmatic access to interactive shell sessions running inside a Hoody container. It exposes the same capabilities surfaced by the in-browser terminal UI: running commands, streaming output, managing long-lived sessions, monitoring system resources, driving TUI applications, and staging files into a session. Use the Terminal API to script workflows, build agents that interact with a shell, or integrate the terminal into external tools.

All Terminal endpoints are container-scoped and operate against the container assigned to your API token. The base URL follows the pattern https://{containerId}.containers.hoody.com, and authentication uses a Bearer token carried in the Authorization header.

Available endpoints

Section titled “Available endpoints”

Command Execution

Execute commands inside the container and retrieve their output synchronously or asynchronously.

Open Command Execution

Session Management

List active shell sessions, inspect their state, connect over WebSocket, and terminate sessions you no longer need.

Open Session Management

Web Interface

Open the in-browser terminal UI directly, or generate a signed URL that grants temporary access to a session.

Open Web Interface

System Monitoring

Read CPU, memory, disk, and process metrics, and enumerate listening network ports for the container.

Open System Monitoring

Terminal Automation

Drive TUI applications programmatically: snapshot the screen, search for text, send keystrokes, paste content, and wait for conditions.

Open Terminal Automation

File Drag-and-Drop

Stage files into a specific session and inject them as a drag-and-drop frame so the running shell or editor receives the drop event.

Open File Drag-and-Drop

Choosing the right endpoint

Section titled “Choosing the right endpoint”

Most workflows fall into one of three patterns:

  • One-shot commands. If you need to run a single command and read its output, use the Command Execution endpoints. They handle argument escaping and stream capture for you.
  • Interactive shells. If you need a long-running shell you can attach to, send input to, and read output from over time, use the Session Management endpoints to create a session and then stream it over WebSocket.
  • TUI automation. If you need to drive a full-screen application like vim, htop, or a custom REPL, use the Terminal Automation endpoints to take snapshots, search the rendered screen, and send keystrokes deterministically.

The remaining pages cover supporting concerns: opening the Web Interface for human access, querying System Monitoring for runtime telemetry, and using File Drag-and-Drop to push file contents into a session as if a user had dragged them onto the terminal.

Authentication

Section titled “Authentication”

Every Terminal request must include a Bearer token:

Authorization: Bearer <token>

The token is the same container-scoped credential issued when the container was provisioned. It identifies the target container and authorizes operations against it; no separate host or path is needed because the container ID is encoded in the subdomain.