Walk the edges from a seed set, bounded

POST /v1/graph/neighbors

Graph → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/graph/neighbors`
Method	`POST`
Operation	`graphNeighbors`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Request

5 fields, body application/json (required).

Field	In	Type	Required	Description
`as_of`	body	string	—	AsOf walks the graph as it stood at an instant, RFC 3339.
`depth`	body	integer	—	Depth is how many hops.
`direction`	body	string	—	Direction is out, in or both. Out follows an edge from its entity to its value — what the node points at; in follows it the other way — what points at the…
`relation`	body	string	—	Relation narrows the walk to one edge relation. Absent follows all.
`seeds`	body	string[]	—	Seeds is where the walk starts.

Response

Status	Body	Meaning
`200`	graphNeighborsOut	ok

200 body — 4 fields.

Field	In	Type	Always	Description
`bound`	body	integer	—	Bound is the ceiling this walk was held to, the same for every caller, so Truncated can be read against a number rather than guessed at.
`depth`	body	integer	—	Depth is the deepest hop count actually reached.
`entities`	body	string[]	—	Entities is everything reached, the seeds included, ordered by the fewest hops that reach each one and then by key.
`truncated`	body	boolean	—	Truncated says the bound stopped the walk.

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, GraphApi } from 'hanzoai';

const api = new GraphApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.graphNeighbors({ as_of: "<as_of>", depth: 0 });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import GraphApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = GraphApi(client).graph_neighbors(as_of="<as_of>", depth=0)

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

resp, _, err := client.GraphAPI.GraphNeighbors(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, graph_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = graph_api::graph_neighbors(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.GraphApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new GraphApi(client).graphNeighbors();

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 -X POST https://api.hanzo.ai/v1/graph/neighbors \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "as_of": "<as_of>",
       "depth": 0
     }'

The door declares no tool for graph — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.

Graph API · All Hanzo APIs · Interactive reference

Walk the edges from a seed set, bounded

Request

Response

Examples

On this page