Actions44
- Edge Actions
- Entity Type Actions
- Episode Actions
- Graph Actions
- Node Actions
- Session Actions
- Thread Actions
- User Actions
Overview
The "Add User" operation of the User resource in this node allows you to create a new user record in the Zep Cloud v3 API. This operation is useful for scenarios where you want to programmatically register or onboard users into the Zep system, enabling them to be tracked or associated with other data such as threads, nodes, or graphs.
Typical use cases include:
- Adding new users from an external system or CRM into Zep.
- Automating user creation during onboarding workflows.
- Enriching user profiles with metadata and custom fact rating instructions.
For example, you might add a user with their email, first name, last name, and additional metadata like department and role. Optionally, you can provide instructions on how facts related to this user should be rated for relevance and accuracy.
Properties
| Name | Meaning |
|---|---|
| User ID | The unique identifier of the user (required). |
The user's email address. Example: user@example.com. |
|
| First Name | The user's first name. Example: John. |
| Last Name | The user's last name. Example: Doe. |
| Metadata | JSON object containing additional metadata about the user. Example: {"department": "engineering", "role": "developer"}. |
| Fact Rating Instruction | Optional instructions for rating facts related to the user. Includes: - Instruction: Main instruction text (e.g., "Rate facts based on relevance and accuracy"). - High Rating Example: Example of high-rated fact. - Medium Rating Example: Example of medium-rated fact. - Low Rating Example: Example of low-rated fact. |
Output
The output JSON contains the response from the Zep Cloud API after creating the user. This typically includes details of the newly created user such as their user ID and any other relevant information returned by the API.
No binary data is output by this operation.
Dependencies
- Requires an API key credential configured in n8n for authenticating requests to the Zep Cloud API.
- The node makes HTTP POST requests to
https://api.getzep.com/api/v2/usersendpoint. - Proper network connectivity to the Zep Cloud API is required.
Troubleshooting
- Missing Required Fields: If the User ID is not provided, the node will fail because it is required.
- Invalid JSON in Metadata: The metadata field expects a valid JSON string. Invalid JSON will cause parsing errors.
- API Authentication Errors: Ensure that the API key credential is correctly set up and has permissions to create users.
- Fact Rating Instruction Format: If fact rating instructions are provided, ensure at least one of the instruction or examples fields is filled; otherwise, they will be ignored.
- HTTP Errors: Network issues or invalid parameters may result in HTTP errors. Check the error message returned by the node for details.
Links and References
- Zep Cloud API Documentation (for detailed API usage and user management)
- n8n HTTP Request Node Documentation (for understanding HTTP request handling in n8n)
This summary is based solely on static analysis of the provided source code and property definitions.