Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Actions44

Overview

The node interacts with the Zep Cloud v3 API to manage and retrieve data related to knowledge graphs, including episodes, nodes, edges, users, threads, sessions, and entity types. Specifically, for the Episode resource with the Get Graph Episodes operation, it fetches all episodes associated with a specified graph by its unique identifier.

This operation is useful when you want to analyze or process events or episodes that are part of a particular knowledge graph. For example, you might use this to retrieve all recorded interactions or events linked to a graph representing customer interactions, enabling further analysis or integration with other systems.

Properties

Name Meaning
Graph ID The unique identifier of the graph whose episodes you want to retrieve. This is required to specify which graph's episodes to fetch.

Output

The output is a JSON array containing episode objects retrieved from the Zep Cloud API for the specified graph. Each episode object typically includes details such as the episode's unique identifier, data content, type, timestamps, and any metadata associated with the episode.

The node does not output binary data for this operation; all returned data is in JSON format representing the episodes.

Dependencies

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

Troubleshooting

  • Missing or invalid Graph ID: If the Graph ID is not provided or incorrect, the API call will fail. Ensure the Graph ID is correctly set.
  • Authentication errors: If the API key credential is missing or invalid, requests will be rejected. Verify the API key setup.
  • API rate limits or network issues: Network problems or exceeding API rate limits can cause request failures. Check connectivity and API usage quotas.
  • Unexpected response structure: If the API changes, the node may receive unexpected data formats. Review API documentation for updates.

Common error messages include:

  • "Unknown episode operation: getByGraph" — indicates the operation name was misspelled or unsupported.
  • "Either Graph ID or User ID must be provided" — ensure the Graph ID is supplied for this operation.

Resolving these usually involves verifying input parameters and credentials.

Links and References

Additional Notes on Implementation (Static Analysis)

  • The method handling "Get Graph Episodes" calls the endpoint:
    GET https://api.getzep.com/api/v2/graph/episodes/graph/{graphId}
  • It uses the graphId parameter from the node input.
  • The node uses a helper method to perform authenticated HTTP requests.
  • The response is returned as JSON and wrapped into n8n's execution metadata for downstream processing.

Discussion