List node neighbors

POST

https://api.getzep.com/api/v4/graphs/:graph_uuid/nodes/:node_uuid/neighbors

POST

/api/v4/graphs/:graph_uuid/nodes/:node_uuid/neighbors

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.node.list_neighbors(
    graph_uuid="graph_uuid",
    node_uuid="node_uuid",
)

{
  "items": [
    {
      "edges": [
        {
          "attributes": {},
          "created_at": "string",
          "episode_uuids": [
            "string"
          ],
          "expired_at": "string",
          "fact": "string",
          "graph_uuid": "string",
          "hyperedge_uuid": "string",
          "invalid_at": "string",
          "name": "string",
          "relevance": 1.1,
          "scope": "string",
          "score": 1.1,
          "source_node_labels": [
            "string"
          ],
          "source_node_name": "string",
          "source_node_uuid": "string",
          "target_node_labels": [
            "string"
          ],
          "target_node_name": "string",
          "target_node_uuid": "string",
          "user_uuid": "string",
          "uuid": "string",
          "valid_at": "string"
        }
      ],
      "node": {
        "episode_uuids": [
          "string"
        ],
        "episode_uuids_truncated": true,
        "attributes": {},
        "created_at": "string",
        "degree": 1,
        "graph_uuid": "string",
        "labels": [
          "string"
        ],
        "name": "string",
        "relevance": 1.1,
        "score": 1.1,
        "summary": "string",
        "user_uuid": "string",
        "uuid": "string"
      }
    }
  ],
  "next_cursor": "string",
  "total_size": 1
}

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Path parameters

graph_uuidstringRequired

The UUID of the graph. For a user graph, you can also use the UUID of the user.

node_uuidstringRequired

Node UUID

Query parameters

page_sizeintegerOptional1-100Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional

Opaque page cursor

order_byenumOptional

Sort field

Allowed values:

orderenumOptional

Sort direction: asc or desc

Allowed values:

Request

Request body

directionenumOptional

The edge orientation to follow from the node: in, out, or both.

Allowed values:

filtersobjectOptional

Filters constraining the connecting edges and the neighbor nodes.

Response

itemslist of objectsOptional

The neighboring nodes and their connecting edges on this page.

next_cursorstringOptional

The cursor to pass as the next request’s cursor to fetch the following page; absent when no further pages remain.

total_sizeintegerOptional

Omitted for this collection; use next_cursor to detect the end of pagination.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error