# Node

URL: https://docs.hanzo.ai/docs/openapi/node

> Your machines: the ones you own, connected and ready to take a command.

Also for this capability: **API** · [CLI](https://docs.hanzo.ai/docs/cli/node) · [SDKs](https://docs.hanzo.ai/docs/sdks)

Your machines: the ones you own, connected and ready to take a command.

> [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|                |                                        |
| -------------- | -------------------------------------- |
| **Base URL**   | `https://api.hanzo.ai`                 |
| **Operations** | 4                                      |
| **Auth**       | `Authorization: Bearer $HANZO_API_KEY` |

## Specification

Specification pending — no HIP in [hanzoai/hips](https://github.com/hanzoai/hips) declares `capability: node` 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** | `node` at its own prefix                     | 4 operations                                                             |
| **CLI**  | `hanzo node …`                               | 4 of 4                                                                   |
| **SDK**  | `NodeApi` in every published client          | 4 methods                                                                |
| **MCP**  | tool `node` on `https://api.hanzo.ai/v1/mcp` | 1 operation, 0 under the document's own id — ask `describe` for the rest |

## Quickstart

```bash
export HANZO_API_KEY=sk-...   # console.hanzo.ai → API keys
```

Then the first call — a read that needs nothing but the key. `GET /v1/node`, operation `get_node`:

**CLI**

```bash
hanzo node list
```

**SDK**

**.ts**

```ts
import { Configuration, NodeApi } from 'hanzoai';

const api = new NodeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getNode();
```

**.py**

```python
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()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.NodeAPI.GetNode(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::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?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.NodeApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new NodeApi(client).getNode();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/node \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **node** through the `node` tool, which names its 1 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
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": "list_nodes"
         }
       }
     }'
```

Answers `200` with `object` — ok.

## Endpoints

| Endpoint                                                                                      | What it does                                                                                                                                                                                                    |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`POST /v1/node/{id}/invoke`](https://docs.hanzo.ai/docs/openapi/node/post-node-by-id-invoke) | Ask one of your connected machines to run a command, and get its answer back.                                                                                                                                   |
| [`GET /v1/node/connect`](https://docs.hanzo.ai/docs/openapi/node/get-node-connect)            | The socket a bot node dials and holds open to become invokable.                                                                                                                                                 |
| [`POST /v1/node/peer/invoke`](https://docs.hanzo.ai/docs/openapi/node/post-node-peer-invoke)  | Replica-to-replica forward of one invocation to the pod holding the node's socket.                                                                                                                              |
| [`GET /v1/node`](https://docs.hanzo.ai/docs/openapi/node/get-node)                            | 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. |

---

[All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)