Returns the caller org's currently connected bot nodes: what each one calls…
Returns the caller org's currently connected bot nodes: what each one calls itself, the platform it runs on, its agent version, when its socket was…
GET /v1/node
| Address | https://api.hanzo.ai/v1/node |
| Method | GET |
| Operation | get_node |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the caller org's currently connected bot nodes: what each one calls itself, the platform it runs on, its agent version, when its socket was established, and the capabilities and commands it reported.
Only this org's nodes are listed — the org is half of every key in the table it reads — and only nodes attached to THIS replica, because the list is of live sockets rather than of registrations. The capability and command lists are the node's own self-report: useful to show, never load-bearing, because what a node may actually be asked to do is decided at the socket against the deployment's allowlist.
Request
GET /v1/node takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | nodesView | ok |
200 body — 8 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
nodes | body | nodeView[] | — | Nodes is every node of the caller's org with a live socket to THIS replica, ordered by id. |
nodes[].caps | body | string[] | — | Caps is the capability list the node reported. |
nodes[].commands | body | string[] | — | Commands is the command list the node reported. |
nodes[].connectedAt | body | string | — | ConnectedAt is when this node's socket was established, RFC3339 UTC. |
nodes[].displayName | body | string | — | DisplayName is the human name the node reported for itself. |
nodes[].id | body | string | — | ID is the node's own identifier within the org — the value POST /v1/node/{id}/invoke addresses it by. |
nodes[].platform | body | string | — | Platform is the operating system and architecture the node reported. |
nodes[].version | body | string | — | Version is the node agent's own version string. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, NodeApi } from 'hanzoai';
const api = new NodeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getNode();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import NodeApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = NodeApi(client).get_node()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.NodeAPI.GetNode(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, node_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = node_api::get_node(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.NodeApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new NodeApi(client).getNode();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/node \
-H "Authorization: Bearer $HANZO_API_KEY"The door declares no tool for node — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?