Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Actions44

Overview

The "List Sessions" operation of the Session resource in this node interacts with the Zep Cloud v3 API to retrieve a paginated list of sessions. This operation is useful for scenarios where you need to fetch multiple session records, such as auditing user activity, analyzing session data, or displaying session lists in dashboards.

For example, you might use this operation to:

  • Retrieve all active or historical sessions for a user or system.
  • Paginate through sessions to process or export session data.
  • Sort sessions by creation date, update time, or other criteria to find recent or specific sessions.

Properties

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

Output

The output is a JSON array containing session objects retrieved from the Zep Cloud API. Each item represents a session with its associated metadata as returned by the API. The exact structure depends on the API response but typically includes session identifiers, timestamps, user associations, and other session details.

This node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Zep Cloud v3 API.
  • The base URL for API requests is https://api.getzep.com.
  • 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 communication with the Zep Cloud API.

  • Error messages:

    • "Unknown session operation: <operation>" indicates an unsupported operation was requested.
    • HTTP errors from the API (e.g., 401 Unauthorized, 400 Bad Request) usually relate to credential issues or invalid parameters.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has appropriate permissions.
    • Ensure pagination parameters are within valid ranges.
    • Check network connectivity and proxy settings if applicable.

Links and References

Discussion