zep-users

Zep Users - user management, threads, messages, and tasks

Server path: /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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "disable_default_ontology": {
      "type": "boolean",
      "description": "When true, disables the use of default/fallback ontology for the user's graph."
    },
    "email": {
      "type": "string",
      "description": "The email address of the user."
    },
    "first_name": {
      "type": "string",
      "description": "The first name of the user."
    },
    "last_name": {
      "type": "string",
      "description": "The last name of the user."
    },
    "metadata": {
      "type": "object",
      "description": "The metadata associated with the user."
    },
    "user_id": {
      "type": "string",
      "description": "The unique identifier of the user."
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "threadId": {
      "type": "string",
      "description": "The ID of the thread to which messages should be added."
    },
    "ignore_roles": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "norole",
          "system",
          "assistant",
          "user",
          "function",
          "tool"
        ]
      },
      "description": "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": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "description": "The content of the message."
          },
          "created_at": {
            "type": "string",
            "description": "The timestamp of when the message was created."
          },
          "metadata": {
            "type": "object",
            "description": "The metadata associated with the message."
          },
          "name": {
            "type": "string",
            "description": "Customizable name of the sender of the message (e.g., \"john\", \"sales_agent\")."
          },
          "processed": {
            "type": "boolean",
            "description": "Whether the message has been processed."
          },
          "role": {
            "type": "string",
            "enum": [
              "norole",
              "system",
              "assistant",
              "user",
              "function",
              "tool"
            ],
            "description": "The role value"
          },
          "uuid": {
            "type": "string",
            "description": "The unique identifier of the message."
          }
        },
        "required": [
          "content",
          "role"
        ]
      },
      "description": "A list of message objects, where each message contains a role and content."
    },
    "return_context": {
      "type": "boolean",
      "description": "Optionally return context block relevant to the most recent messages."
    }
  },
  "required": [
    "PCID",
    "threadId",
    "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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "threadId": {
      "type": "string",
      "description": "The ID of the thread to which messages should be added."
    },
    "ignore_roles": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "norole",
          "system",
          "assistant",
          "user",
          "function",
          "tool"
        ]
      },
      "description": "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": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "description": "The content of the message."
          },
          "created_at": {
            "type": "string",
            "description": "The timestamp of when the message was created."
          },
          "metadata": {
            "type": "object",
            "description": "The metadata associated with the message."
          },
          "name": {
            "type": "string",
            "description": "Customizable name of the sender of the message (e.g., \"john\", \"sales_agent\")."
          },
          "processed": {
            "type": "boolean",
            "description": "Whether the message has been processed."
          },
          "role": {
            "type": "string",
            "enum": [
              "norole",
              "system",
              "assistant",
              "user",
              "function",
              "tool"
            ],
            "description": "The role value"
          },
          "uuid": {
            "type": "string",
            "description": "The unique identifier of the message."
          }
        },
        "required": [
          "content",
          "role"
        ]
      },
      "description": "A list of message objects, where each message contains a role and content."
    },
    "return_context": {
      "type": "boolean",
      "description": "Optionally return context block relevant to the most recent messages."
    }
  },
  "required": [
    "PCID",
    "threadId",
    "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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "instructions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "text": {
            "type": "string",
            "description": "The text value"
          }
        },
        "required": [
          "name",
          "text"
        ]
      },
      "description": "Instructions to add to the user summary generation."
    },
    "user_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "User IDs to add the instructions to. If empty, the instructions are added to the project-wide default."
    }
  },
  "required": [
    "PCID",
    "instructions"
  ]
}

---

zep_users_delete

Delete User

Parameters:

Parameter	Type	Required	Default	Description
userId	string	Yes	—	User ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "threadId": {
      "type": "string",
      "description": "The ID of the thread for which memory should be deleted."
    }
  },
  "required": [
    "PCID",
    "threadId"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "instruction_names": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Unique identifier for the instructions to be deleted. If empty deletes all instructions."
    },
    "user_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Determines which users will have their custom instructions deleted. If no users are provided, the project-wide custom instructions will be effected."
    }
  },
  "required": [
    "PCID"
  ]
}

---

zep_users_get

Get User

Parameters:

Parameter	Type	Required	Default	Description
userId	string	Yes	—	The user_id of the user to get.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "The user_id of the user to get."
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "threadId": {
      "type": "string",
      "description": "Thread ID"
    },
    "limit": {
      "type": "integer",
      "description": "Limit the number of results returned"
    },
    "cursor": {
      "type": "integer",
      "description": "Cursor for pagination"
    },
    "lastn": {
      "type": "integer",
      "description": "Number of most recent messages to return (overrides limit and cursor)"
    }
  },
  "required": [
    "PCID",
    "threadId"
  ]
}

---

zep_users_get_task

Get Task

Parameters:

Parameter	Type	Required	Default	Description
task_id	string	Yes	—	Task ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "task_id": {
      "type": "string",
      "description": "Task ID"
    }
  },
  "required": [
    "PCID",
    "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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page_number": {
      "type": "integer",
      "description": "Page number for pagination, starting from 1"
    },
    "page_size": {
      "type": "integer",
      "description": "Number of threads to retrieve per page."
    },
    "order_by": {
      "type": "string",
      "description": "Field to order the results by: created_at, updated_at, user_id, thread_id."
    },
    "asc": {
      "type": "boolean",
      "description": "Order direction: true for ascending, false for descending."
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "threadId": {
      "type": "string",
      "description": "The ID of the current thread (for which context is being retrieved)."
    },
    "template_id": {
      "type": "string",
      "description": "Optional template ID to use for custom context rendering."
    }
  },
  "required": [
    "PCID",
    "threadId"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "The user_id of the user to get the node for."
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

zep_users_get_user_threads

Get User Threads

Parameters:

Parameter	Type	Required	Default	Description
userId	string	Yes	—	User ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number for pagination, starting from 1"
    },
    "pageSize": {
      "type": "integer",
      "description": "Number of users to retrieve per page"
    },
    "search": {
      "type": "string",
      "description": "Search term for filtering users by user_id, name, or email"
    },
    "order_by": {
      "type": "string",
      "description": "Column to sort by (created_at, user_id, email)"
    },
    "asc": {
      "type": "boolean",
      "description": "Sort in ascending order"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "string",
      "description": "User ID to get user-specific instructions"
    }
  },
  "required": [
    "PCID"
  ]
}

---

zep_users_retrieves_project_information

Retrieves project information

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

zep_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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "thread_id": {
      "type": "string",
      "description": "The unique identifier of the thread."
    },
    "user_id": {
      "type": "string",
      "description": "The unique identifier of the user associated with the thread"
    }
  },
  "required": [
    "PCID",
    "thread_id",
    "user_id"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "disable_default_ontology": {
      "type": "boolean",
      "description": "When true, disables the use of default/fallback ontology for the user's graph."
    },
    "email": {
      "type": "string",
      "description": "The email address of the user."
    },
    "first_name": {
      "type": "string",
      "description": "The first name of the user."
    },
    "last_name": {
      "type": "string",
      "description": "The last name of the user."
    },
    "metadata": {
      "type": "object",
      "description": "The metadata to update"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messageUUID": {
      "type": "string",
      "description": "The UUID of the message."
    },
    "metadata": {
      "type": "object",
      "description": "The metadata value"
    }
  },
  "required": [
    "PCID",
    "messageUUID",
    "metadata"
  ]
}

---

zep_users_warm_user_cache

Warm User Cache

Parameters:

Parameter	Type	Required	Default	Description
userId	string	Yes	—	User ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}