Bot
A bot doing your work on a real desktop, live, while you watch.
Also for this capability: API · CLI · SDKs
A bot doing your work on a real desktop, live, while you watch.
| Base URL | https://api.hanzo.ai |
| Operations | 3 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Specification
Specification pending — no HIP in hanzoai/hips declares capability: bot yet. What this capability serves is below, from the API document; what it is — the store it owns, how it meters, what it publishes — is written as a HIP under HIP-0139.
Four surfaces
| Surface | Reaches this capability as | Coverage |
|---|---|---|
| REST | bot at its own prefix | 3 operations |
| CLI | hanzo bot … | 3 of 3 |
| SDK | BotApi in every published client | 3 methods |
| MCP | tool bot on https://api.hanzo.ai/v1/mcp | 4 operations, 0 under the document's own id — ask describe for the rest |
Quickstart
export HANZO_API_KEY=sk-... # console.hanzo.ai → API keysThen the first call — a read that needs nothing but the key. GET /v1/bot/runs, operation get_bot_runs:
hanzo bot runs listimport { Configuration, BotApi } from 'hanzoai';
const api = new BotApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBotRuns();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BotApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BotApi(client).get_bot_runs()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.BotAPI.GetBotRuns(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, bot_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = bot_api::get_bot_runs(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BotApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new BotApi(client).getBotRuns();curl https://api.hanzo.ai/v1/bot/runs \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches bot through the bot tool, which names its 4 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_bot_connect"
}
}
}'Answers 200 with object — ok.
Endpoints
| Endpoint | What it does |
|---|---|
POST /v1/bot/runs/{runId}/stop | Stop terminates one of the caller org's own bot runs and reports its terminal state. |
GET /v1/bot/runs | List returns the caller org's live bot runs, read from the bot runtime and projected into the console contract with each run's live session URL… |
POST /v1/bot/runs | Answers 501 to every call: launching a bot run is not implemented. |
How is this guide?