Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Overview

The "Get Edge" operation of the Zep node allows users to retrieve detailed information about a specific edge in a knowledge graph by providing its UUID. This node interacts with the Zep Cloud v3 API, which manages graphs consisting of nodes and edges representing entities and their relationships.

This operation is beneficial when you want to fetch metadata or properties of a particular relationship (edge) between entities in your graph. For example, if you have a graph representing an organization's structure, you can get details about the "works_for" relationship between an employee node and a company node by specifying the edge's UUID.

Practical scenarios include:

  • Inspecting specific relationships in a knowledge graph for analysis or reporting.
  • Validating or auditing connections between entities.
  • Integrating graph data retrieval into workflows that require relationship context.

Properties

Name Meaning
Graph ID The unique identifier of the graph. Optional for this operation but required for some others.
UUID The universally unique identifier of the edge to retrieve. This is required.

Output

The output JSON contains the detailed information of the requested edge as returned by the Zep Cloud API. This typically includes fields such as the edge's UUID, source and target nodes, fact name, fact description, timestamps, and any metadata associated with the edge.

The node does not output binary data; all outputs are JSON objects representing the edge's data.

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 API key credential in n8n is necessary for successful execution.

Troubleshooting

  • Missing UUID: If the UUID property is not provided or is invalid, the API call will fail. Ensure the UUID is correctly set.
  • Authentication Errors: If the API key credential is missing or invalid, the node will throw authentication errors. Verify the API key setup.
  • Network Issues: Connectivity problems to api.getzep.com will cause request failures. Check network access and firewall settings.
  • Edge Not Found: If the specified UUID does not correspond to an existing edge, the API may return a 404 error. Confirm the UUID is correct.
  • API Rate Limits: Excessive requests might be throttled by the API. Implement retry logic or reduce request frequency if needed.

Links and References


This summary focuses on the "Get Edge" operation within the "Edge" resource of the Zep node, based on static code analysis of the provided source code and input property definitions.

Discussion