/zep-users | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
zep_users_add | Add User |
zep_users_add_messages_to_a_thread | Add messages to a thread |
zep_users_add_messages_to_a_thread_in_batch | Add messages to a thread in batch |
zep_users_add_user_instructions | Add User Instructions |
zep_users_delete | Delete User |
zep_users_delete_thread | Delete thread |
zep_users_delete_user_instructions | Delete User Instructions |
zep_users_get | Get User |
zep_users_get_messages_of_a_thread | Get messages of a thread |
zep_users_get_task | Get Task |
zep_users_get_threads | Get threads |
zep_users_get_user_context | Get user context |
zep_users_get_user_node | Get User Node |
zep_users_get_user_threads | Get User Threads |
zep_users_list_ordered | Get Users |
zep_users_list_user_instructions | List User Instructions |
zep_users_retrieves_project_information | Retrieves project information |
zep_users_start_a_new_thread | Start a new thread. |
zep_users_update | Update User |
zep_users_updates_a_message | Updates a message. |
zep_users_warm_user_cache | Warm User Cache |
zep_users_add
Add User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
disable_default_ontology | boolean | No | — | When true, disables the use of default/fallback ontology for the user’s graph. |
email | string | No | — | The email address of the user. |
first_name | string | No | — | The first name of the user. |
last_name | string | No | — | The last name of the user. |
metadata | object | No | — | The metadata associated with the user. |
user_id | string | Yes | — | The unique identifier of the user. |
zep_users_add_messages_to_a_thread
Add messages to a thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | The ID of the thread to which messages should be added. |
ignore_roles | string[] | No | — | Optional list of role types to ignore when adding messages to graph memory. The message itself will still be added, retained and used as context for messages that are added to a user’s graph. |
messages | object[] | Yes | — | A list of message objects, where each message contains a role and content. |
return_context | boolean | No | — | Optionally return context block relevant to the most recent messages. |
zep_users_add_messages_to_a_thread_in_batch
Add messages to a thread in batch Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | The ID of the thread to which messages should be added. |
ignore_roles | string[] | No | — | Optional list of role types to ignore when adding messages to graph memory. The message itself will still be added, retained and used as context for messages that are added to a user’s graph. |
messages | object[] | Yes | — | A list of message objects, where each message contains a role and content. |
return_context | boolean | No | — | Optionally return context block relevant to the most recent messages. |
zep_users_add_user_instructions
Add User Instructions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
instructions | object[] | Yes | — | Instructions to add to the user summary generation. |
user_ids | string[] | No | — | User IDs to add the instructions to. If empty, the instructions are added to the project-wide default. |
zep_users_delete
Delete User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
zep_users_delete_thread
Delete thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | The ID of the thread for which memory should be deleted. |
zep_users_delete_user_instructions
Delete User Instructions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
instruction_names | string[] | No | — | Unique identifier for the instructions to be deleted. If empty deletes all instructions. |
user_ids | string[] | No | — | Determines which users will have their custom instructions deleted. If no users are provided, the project-wide custom instructions will be effected. |
zep_users_get
Get User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | The user_id of the user to get. |
zep_users_get_messages_of_a_thread
Get messages of a thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | Thread ID |
limit | integer | No | — | Limit the number of results returned |
cursor | integer | No | — | Cursor for pagination |
lastn | integer | No | — | Number of most recent messages to return (overrides limit and cursor) |
zep_users_get_task
Get Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task ID |
zep_users_get_threads
Get threads Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page_number | integer | No | — | Page number for pagination, starting from 1 |
page_size | integer | No | — | Number of threads to retrieve per page. |
order_by | string | No | — | Field to order the results by: created_at, updated_at, user_id, thread_id. |
asc | boolean | No | — | Order direction: true for ascending, false for descending. |
zep_users_get_user_context
Get user context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | The ID of the current thread (for which context is being retrieved). |
template_id | string | No | — | Optional template ID to use for custom context rendering. |
zep_users_get_user_node
Get User Node Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | The user_id of the user to get the node for. |
zep_users_get_user_threads
Get User Threads Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
zep_users_list_ordered
Get Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number for pagination, starting from 1 |
pageSize | integer | No | — | Number of users to retrieve per page |
search | string | No | — | Search term for filtering users by user_id, name, or email |
order_by | string | No | — | Column to sort by (created_at, user_id, email) |
asc | boolean | No | — | Sort in ascending order |
zep_users_list_user_instructions
List User Instructions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | No | — | User ID to get user-specific instructions |
zep_users_retrieves_project_information
Retrieves project informationzep_users_start_a_new_thread
Start a new thread. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
thread_id | string | Yes | — | The unique identifier of the thread. |
user_id | string | Yes | — | The unique identifier of the user associated with the thread |
zep_users_update
Update User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
disable_default_ontology | boolean | No | — | When true, disables the use of default/fallback ontology for the user’s graph. |
email | string | No | — | The email address of the user. |
first_name | string | No | — | The first name of the user. |
last_name | string | No | — | The last name of the user. |
metadata | object | No | — | The metadata to update |
zep_users_updates_a_message
Updates a message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageUUID | string | Yes | — | The UUID of the message. |
metadata | object | Yes | — | The metadata value |
zep_users_warm_user_cache
Warm User Cache Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |

