Assemble graph context

POST

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

POST

/api/v4/graphs/:graph_uuid/context

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.get_context(
    graph_uuid="graph_uuid",
    query="string",
)

{
  "context": "string",
  "results": {
    "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,
        "selection_rank": 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"
      }
    ],
    "episodes": [
      {
        "content": "string",
        "content_policy": {
          "category_keys": [
            "health"
          ],
          "dropped_count": 0,
          "retained_count": 7,
          "revision": 3,
          "status": "complete",
          "violated": false
        },
        "created_at": "string",
        "document_id": "string",
        "graph_uuid": "string",
        "metadata": {},
        "processed": true,
        "relevance": 1.1,
        "role": "system",
        "role_name": "string",
        "score": 1.1,
        "selection_rank": 1,
        "source": "text",
        "source_description": "string",
        "thread_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,
        "selection_rank": 1,
        "summary": "string",
        "uuid": "string"
      }
    ],
    "observations": [
      {
        "attributes": {},
        "created_at": "string",
        "episode_uuids": [
          "string"
        ],
        "graph_uuid": "string",
        "labels": [
          "string"
        ],
        "name": "string",
        "relevance": 1.1,
        "score": 1.1,
        "selection_rank": 1,
        "summary": "string",
        "uuid": "string"
      }
    ],
    "thread_summaries": [
      {
        "created_at": "string",
        "last_summarized_at": "string",
        "last_summarized_episode_valid_at": "string",
        "relevance": 1.1,
        "score": 1.1,
        "selection_rank": 1,
        "summary": "string",
        "thread_uuid": "string",
        "uuid": "string"
      }
    ]
  },
  "truncated": true
}

Authentication

AuthorizationApi-Key

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

Path parameters

graph_uuidstringRequired

Graph UUID

Request

Request body

querystringRequired

The search query used to assemble the context block.

filtersobjectOptional

Filters constraining which graph data can be selected for the context block.

include_resultsbooleanOptional

When true, includes the raw graph results selected for the context block.

max_charactersintegerOptional1-50000

The maximum number of characters in the assembled context block.

recency_biasenumOptional

Adjusts result selection to favor more recent graph data.

Allowed values:

template_uuidstringOptional

The UUID of a context template used to render the context block.

Response

contextstringOptional

The assembled context block of facts, entities, observations, and thread summaries. Pass it through the model provider's untrusted-data channel.

resultsobjectOptional

The individual edges, nodes, episodes, observations, and thread summaries selected to build the context. Episodes are always empty because context assembly does not select episodes. Present only when requested.

truncatedbooleanOptional

Whether the character budget limited the size of the context block.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error