Get subgraph

POST

https://api.getzep.com/api/v4/graphs/:graph_uuid/subgraph

POST

/api/v4/graphs/:graph_uuid/subgraph

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.get_subgraph(
    graph_uuid="graph_uuid",
    seed_node_uuids=[
        "string"
    ],
)

{
  "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",
      "uuid": "string",
      "valid_at": "string"
    }
  ],
  "nodes": [
    {
      "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",
      "uuid": "string"
    }
  ],
  "truncated": true,
  "truncation_reason": "string"
}

Authentication

AuthorizationApi-Key

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

Path parameters

graph_uuidstringRequired

Graph UUID

Request

Request body

seed_node_uuidslist of stringsRequired

The node UUIDs to expand from, in traversal-priority order.

depthintegerOptional1-3

The maximum traversal depth from the seed nodes. Defaults to 1.

directionenumOptional

The edge orientation to follow during expansion: in, out, or both. Defaults to both.

Allowed values:

filtersobjectOptional

Filters constraining the traversed edges and included nodes.

max_edgesintegerOptional1-1000

The maximum number of edges in the response. Defaults to 200.

max_nodesintegerOptional1-500

The maximum number of nodes in the response. Defaults to 100.

Response

edgeslist of objectsOptional

Every traversed edge that passed the request filters; both endpoints of every edge are present in nodes.

nodeslist of objectsOptional

Every admitted seed node and every node reached within the traversal budget.

truncatedbooleanOptional

Whether any budget or limit reduced the result.

truncation_reasonstringOptional

The binding limit that caused truncation, such as max_nodes or max_edges; present only when truncated is true.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error