Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Overview

This node interacts with the Zep Cloud v3 API to retrieve any nodes and edges mentioned in a specific episode within a knowledge graph. It is useful for scenarios where you want to analyze or visualize the relationships and entities referenced during an episode of data, such as conversations, events, or interactions recorded in the system.

For example, if you have an episode representing a customer support call or a meeting transcript, this operation can extract all the relevant entities (nodes) and their relationships (edges) mentioned during that episode. This helps in understanding context, mapping connections, or further processing the data for insights.

Properties

Name Meaning
UUID The unique identifier (UUID) of the episode from which to return any nodes and edges mentioned.

Output

The output JSON contains the nodes and edges referenced in the specified episode. Typically, this will include:

  • Nodes: Entities mentioned or involved in the episode.
  • Edges: Relationships or connections between those entities as identified in the episode.

The exact structure depends on the API response but generally includes arrays or collections of node and edge objects with their properties.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Zep Cloud v3 API.
  • The node makes HTTP requests to https://api.getzep.com endpoints.
  • Proper configuration of the "zepApi" credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or missing UUID will cause the API request to fail.
    • Network connectivity problems may prevent successful API calls.
    • Insufficient permissions or incorrect API credentials will result in authentication errors.
  • Error messages:

    • "Unknown episode operation: getNodesAndEdges": Indicates the operation name might be misspelled or not supported; ensure correct operation selection.
    • HTTP 401 Unauthorized: Check that the API key credential is correctly configured and valid.
    • HTTP 404 Not Found: The provided UUID does not correspond to any existing episode.
  • Resolution tips:

    • Verify the UUID input is correct and corresponds to an existing episode.
    • Confirm API credentials are set up properly in n8n.
    • Ensure network access to api.getzep.com is allowed.

Links and References


Additional Notes

The node's execute() method dynamically routes operations based on resource and operation parameters. For the "episode" resource and "getNodesAndEdges" operation, it calls the following internal function:

async function ue(e){
  let a = {
    method: "GET",
    url: `https://api.getzep.com/api/v2/graph/episodes/${this.getNodeParameter("uuid", e)}/nodes-and-edges`,
    json: true,
  };
  return await this.helpers.httpRequestWithAuthentication.call(this, "zepApi", a);
}

This confirms the node performs a GET request to the endpoint /api/v2/graph/episodes/{uuid}/nodes-and-edges to fetch the relevant data.

Discussion