Skip to main content
Server path: /zep-users | Type: Application | PCID required: Yes

Tools

ToolDescription
zep_users_addAdd User
zep_users_add_messages_to_a_threadAdd messages to a thread
zep_users_add_messages_to_a_thread_in_batchAdd messages to a thread in batch
zep_users_add_user_instructionsAdd User Instructions
zep_users_deleteDelete User
zep_users_delete_threadDelete thread
zep_users_delete_user_instructionsDelete User Instructions
zep_users_getGet User
zep_users_get_messages_of_a_threadGet messages of a thread
zep_users_get_taskGet Task
zep_users_get_threadsGet threads
zep_users_get_user_contextGet user context
zep_users_get_user_nodeGet User Node
zep_users_get_user_threadsGet User Threads
zep_users_list_orderedGet Users
zep_users_list_user_instructionsList User Instructions
zep_users_retrieves_project_informationRetrieves project information
zep_users_start_a_new_threadStart a new thread.
zep_users_updateUpdate User
zep_users_updates_a_messageUpdates a message.
zep_users_warm_user_cacheWarm User Cache

zep_users_add

Add User Parameters:
ParameterTypeRequiredDefaultDescription
disable_default_ontologybooleanNoWhen true, disables the use of default/fallback ontology for the user’s graph.
emailstringNoThe email address of the user.
first_namestringNoThe first name of the user.
last_namestringNoThe last name of the user.
metadataobjectNoThe metadata associated with the user.
user_idstringYesThe unique identifier of the user.

zep_users_add_messages_to_a_thread

Add messages to a thread Parameters:
ParameterTypeRequiredDefaultDescription
threadIdstringYesThe ID of the thread to which messages should be added.
ignore_rolesstring[]NoOptional 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.
messagesobject[]YesA list of message objects, where each message contains a role and content.
return_contextbooleanNoOptionally 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:
ParameterTypeRequiredDefaultDescription
threadIdstringYesThe ID of the thread to which messages should be added.
ignore_rolesstring[]NoOptional 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.
messagesobject[]YesA list of message objects, where each message contains a role and content.
return_contextbooleanNoOptionally return context block relevant to the most recent messages.

zep_users_add_user_instructions

Add User Instructions Parameters:
ParameterTypeRequiredDefaultDescription
instructionsobject[]YesInstructions to add to the user summary generation.
user_idsstring[]NoUser IDs to add the instructions to. If empty, the instructions are added to the project-wide default.

zep_users_delete

Delete User Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

zep_users_delete_thread

Delete thread Parameters:
ParameterTypeRequiredDefaultDescription
threadIdstringYesThe ID of the thread for which memory should be deleted.

zep_users_delete_user_instructions

Delete User Instructions Parameters:
ParameterTypeRequiredDefaultDescription
instruction_namesstring[]NoUnique identifier for the instructions to be deleted. If empty deletes all instructions.
user_idsstring[]NoDetermines 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesThe user_id of the user to get.

zep_users_get_messages_of_a_thread

Get messages of a thread Parameters:
ParameterTypeRequiredDefaultDescription
threadIdstringYesThread ID
limitintegerNoLimit the number of results returned
cursorintegerNoCursor for pagination
lastnintegerNoNumber of most recent messages to return (overrides limit and cursor)

zep_users_get_task

Get Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask ID

zep_users_get_threads

Get threads Parameters:
ParameterTypeRequiredDefaultDescription
page_numberintegerNoPage number for pagination, starting from 1
page_sizeintegerNoNumber of threads to retrieve per page.
order_bystringNoField to order the results by: created_at, updated_at, user_id, thread_id.
ascbooleanNoOrder direction: true for ascending, false for descending.

zep_users_get_user_context

Get user context Parameters:
ParameterTypeRequiredDefaultDescription
threadIdstringYesThe ID of the current thread (for which context is being retrieved).
template_idstringNoOptional template ID to use for custom context rendering.

zep_users_get_user_node

Get User Node Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesThe user_id of the user to get the node for.

zep_users_get_user_threads

Get User Threads Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

zep_users_list_ordered

Get Users Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number for pagination, starting from 1
pageSizeintegerNoNumber of users to retrieve per page
searchstringNoSearch term for filtering users by user_id, name, or email
order_bystringNoColumn to sort by (created_at, user_id, email)
ascbooleanNoSort in ascending order

zep_users_list_user_instructions

List User Instructions Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringNoUser ID to get user-specific instructions

zep_users_retrieves_project_information

Retrieves project information

zep_users_start_a_new_thread

Start a new thread. Parameters:
ParameterTypeRequiredDefaultDescription
thread_idstringYesThe unique identifier of the thread.
user_idstringYesThe unique identifier of the user associated with the thread

zep_users_update

Update User Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
disable_default_ontologybooleanNoWhen true, disables the use of default/fallback ontology for the user’s graph.
emailstringNoThe email address of the user.
first_namestringNoThe first name of the user.
last_namestringNoThe last name of the user.
metadataobjectNoThe metadata to update

zep_users_updates_a_message

Updates a message. Parameters:
ParameterTypeRequiredDefaultDescription
messageUUIDstringYesThe UUID of the message.
metadataobjectYesThe metadata value

zep_users_warm_user_cache

Warm User Cache Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID