Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Overview

The node interacts with the Zep Cloud v3 API to manage and retrieve conversation threads. Specifically, the "Get Threads" operation under the "Thread" resource fetches a paginated list of threads from the Zep service. This is useful for scenarios where you want to analyze, display, or process multiple conversation threads associated with users or sessions.

Typical use cases include:

  • Retrieving recent conversation threads for customer support analysis.
  • Displaying a list of user conversations in a dashboard.
  • Exporting thread metadata for reporting or archival purposes.

For example, you might use this node to get the first 25 threads sorted by creation date ascending, enabling you to review conversations in chronological order.

Properties

Name Meaning
Page Number The page number for pagination, starting from 1.
Page Size Number of items (threads) to retrieve per page; minimum 1, maximum 100.
Order By Field to order the results by. Options: Created At, Session ID, Thread ID, Updated At, User ID.
Ascending Order Boolean indicating whether to sort in ascending order (true) or descending (false).

Output

The output is a JSON array containing thread objects retrieved from the Zep API. Each item represents a thread with its associated metadata as returned by the API endpoint GET /api/v2/threads.

The exact structure of each thread object depends on the Zep API but typically includes fields such as:

  • Thread ID
  • User ID
  • Creation timestamp
  • Update timestamp
  • Possibly session information or other relevant thread details

No binary data is output by 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/api/v2/threads.
  • Proper configuration of the API key credential in n8n is necessary for successful authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Requesting a page number or page size outside allowed ranges may result in errors or empty responses.
    • Network connectivity issues can prevent reaching the Zep API endpoint.
  • Error messages:

    • Authentication errors typically indicate invalid credentials; verify the API key setup.
    • Validation errors may occur if parameters like pageSize exceed limits (max 100).
    • Unexpected errors from the API should be checked against Zep's API status or logs.
  • Resolution tips:

    • Ensure the API key credential is correctly configured and has appropriate permissions.
    • Use valid pagination parameters within documented limits.
    • Check network access and proxy settings if requests fail.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion