Get Node Neighbors

Enumerates the distinct entity nodes directly connected to a node, together with the edges connecting each to it.

Path parameters

node_uuidstringRequired
Node UUID

Request

Neighbors request
cursorstringOptional

Opaque cursor for pagination, obtained from the Zep-Next-Cursor response header of the previous page.

directionstringOptional

Orientation of the connecting edge relative to the anchor node: “out” (anchor is the edge’s source), “in” (anchor is the edge’s target), or “both” (either). Defaults to “both”.

direction_sortstringOptional

Sort direction for order_by. One of “asc” or “desc”. Defaults to “desc”. Named direction_sort to avoid clashing with the traversal Direction field above.

filtersobjectOptional

Filters constraining the connecting edges (edge types, dates, and the node- and episode-anchored UUID fields) and the neighbor nodes (node_labels/exclude_node_labels). Reuses the graph.search filter type.

limitintegerOptional

Maximum number of neighbor nodes to return. An explicit value is clamped to 50; when omitted, the default page size (100) applies.

order_bystringOptional

Field to sort neighbor nodes by. One of “uuid” or “created_at”. Defaults to “uuid”.

Response headers

Zep-Next-CursorstringOptional

Opaque cursor for the next page of results; absent when there are no more results.

Response

Neighbors
edgeslist of objectsOptional
nodeobjectOptional

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error