# Reference ## Context

client.context.listContextTemplates() -> Zep.ListContextTemplatesResponse

#### 📝 Description

Lists all context templates.

#### 🔌 Usage

```typescript await client.context.listContextTemplates(); ```

#### ⚙️ Parameters

**requestOptions:** `Context.RequestOptions`

client.context.createContextTemplate({ ...params }) -> Zep.ContextTemplateResponse

#### 📝 Description

Creates a new context template.

#### 🔌 Usage

```typescript await client.context.createContextTemplate({ template: "template", templateId: "template_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.CreateContextTemplateRequest`

**requestOptions:** `Context.RequestOptions`

client.context.getContextTemplate(templateId) -> Zep.ContextTemplateResponse

#### 📝 Description

Retrieves a context template by template_id.

#### 🔌 Usage

```typescript await client.context.getContextTemplate("template_id"); ```

#### ⚙️ Parameters

**templateId:** `string` — Template ID

**requestOptions:** `Context.RequestOptions`

client.context.updateContextTemplate(templateId, { ...params }) -> Zep.ContextTemplateResponse

#### 📝 Description

Updates an existing context template by template_id.

#### 🔌 Usage

```typescript await client.context.updateContextTemplate("template_id", { template: "template", }); ```

#### ⚙️ Parameters

**templateId:** `string` — Template ID

**request:** `Zep.UpdateContextTemplateRequest`

**requestOptions:** `Context.RequestOptions`

client.context.deleteContextTemplate(templateId) -> Zep.SuccessResponse

#### 📝 Description

Deletes a context template by template_id.

#### 🔌 Usage

```typescript await client.context.deleteContextTemplate("template_id"); ```

#### ⚙️ Parameters

**templateId:** `string` — Template ID

**requestOptions:** `Context.RequestOptions`

## Graph

client.graph.listCustomInstructions({ ...params }) -> Zep.ListCustomInstructionsResponse

#### 📝 Description

Lists all custom instructions for a project, user, or graph.

#### 🔌 Usage

```typescript await client.graph.listCustomInstructions({ userId: "user_id", graphId: "graph_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.GraphListCustomInstructionsRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.addCustomInstructions({ ...params }) -> Zep.SuccessResponse

#### 📝 Description

Adds new custom instructions for graphs without removing existing ones. If user_ids or graph_ids is empty, adds to project-wide default instructions.

#### 🔌 Usage

```typescript await client.graph.addCustomInstructions({ instructions: [ { name: "name", text: "text", }, ], }); ```

#### ⚙️ Parameters

**request:** `Zep.AddCustomInstructionsRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.deleteCustomInstructions({ ...params }) -> Zep.SuccessResponse

#### 📝 Description

Deletes custom instructions for graphs or project wide defaults.

#### 🔌 Usage

```typescript await client.graph.deleteCustomInstructions(); ```

#### ⚙️ Parameters

**request:** `Zep.DeleteCustomInstructionsRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.listEntityTypes({ ...params }) -> Zep.EntityTypeResponse

#### 📝 Description

Returns all entity types for a project, user, or graph.

#### 🔌 Usage

```typescript await client.graph.listEntityTypes({ userId: "user_id", graphId: "graph_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.GraphListEntityTypesRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.setEntityTypesInternal({ ...params }) -> Zep.SuccessResponse

#### 📝 Description

Sets the entity types for multiple users and graphs, replacing any existing ones.

#### 🔌 Usage

```typescript await client.graph.setEntityTypesInternal(); ```

#### ⚙️ Parameters

**request:** `Zep.EntityTypeRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.add({ ...params }) -> Zep.Episode

#### 📝 Description

Add data to the graph.

#### 🔌 Usage

```typescript await client.graph.add({ data: "data", type: "text", }); ```

#### ⚙️ Parameters

**request:** `Zep.AddDataRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.addBatch({ ...params }) -> Zep.Episode[]

#### 📝 Description

Add data to the graph in batch mode. Episodes are processed sequentially in the order provided.

#### 🔌 Usage

```typescript await client.graph.addBatch({ episodes: [ { data: "data", type: "text", }, ], }); ```

#### ⚙️ Parameters

**request:** `Zep.AddDataBatchRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.addFactTriple({ ...params }) -> Zep.AddTripleResponse

#### 📝 Description

Add a fact triple for a user or group

#### 🔌 Usage

```typescript await client.graph.addFactTriple({ fact: "fact", factName: "fact_name", }); ```

#### ⚙️ Parameters

**request:** `Zep.AddTripleRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.clone({ ...params }) -> Zep.CloneGraphResponse

#### 📝 Description

Clone a user or group graph.

#### 🔌 Usage

```typescript await client.graph.clone(); ```

#### ⚙️ Parameters

**request:** `Zep.CloneGraphRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.create({ ...params }) -> Zep.Graph

#### 📝 Description

Creates a new graph.

#### 🔌 Usage

```typescript await client.graph.create({ graphId: "graph_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.CreateGraphRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.listAll({ ...params }) -> Zep.GraphListResponse

#### 📝 Description

Returns all graphs. In order to list users, use user.list_ordered instead

#### 🔌 Usage

```typescript await client.graph.listAll({ pageNumber: 1, pageSize: 1, orderBy: "order_by", asc: true, }); ```

#### ⚙️ Parameters

**request:** `Zep.GraphListAllRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.detectPatterns({ ...params }) -> Zep.DetectPatternsResponse

#### 📝 Description

Detects structural patterns in a knowledge graph including relationship frequencies, multi-hop paths, co-occurrences, hubs, and clusters. When a query is provided, uses hybrid search to discover seed nodes, detects triple-frequency patterns, and returns resolved edges ranked by relevance.

#### 🔌 Usage

```typescript await client.graph.detectPatterns(); ```

#### ⚙️ Parameters

**request:** `Zep.DetectPatternsRequest`

**requestOptions:** `Graph.RequestOptions`

client.graph.search({ ...params }) -> Zep.GraphSearchResults

#### 📝 Description

Perform a graph search query.

#### 🔌 Usage

```typescript await client.graph.search({ query: "query", }); ```

#### ⚙️ Parameters

**request:** `Zep.GraphSearchQuery`

**requestOptions:** `Graph.RequestOptions`

client.graph.get(graphId) -> Zep.Graph

#### 📝 Description

Returns a graph.

#### 🔌 Usage

```typescript await client.graph.get("graphId"); ```

#### ⚙️ Parameters

**graphId:** `string` — The graph_id of the graph to get.

**requestOptions:** `Graph.RequestOptions`

client.graph.delete(graphId) -> Zep.SuccessResponse

#### 📝 Description

Deletes a graph. If you would like to delete a user graph, make sure to use user.delete instead.

#### 🔌 Usage

```typescript await client.graph.delete("graphId"); ```

#### ⚙️ Parameters

**graphId:** `string` — Graph ID

**requestOptions:** `Graph.RequestOptions`

client.graph.update(graphId, { ...params }) -> Zep.Graph

#### 📝 Description

Updates information about a graph.

#### 🔌 Usage

```typescript await client.graph.update("graphId"); ```

#### ⚙️ Parameters

**graphId:** `string` — Graph ID

**request:** `Zep.UpdateGraphRequest`

**requestOptions:** `Graph.RequestOptions`

## Project

client.project.get() -> Zep.ProjectInfoResponse

#### 📝 Description

Retrieve project info based on the provided api key.

#### 🔌 Usage

```typescript await client.project.get(); ```

#### ⚙️ Parameters

**requestOptions:** `Project.RequestOptions`

## Task

client.task.get(taskId) -> Zep.GetTaskResponse

#### 📝 Description

Gets a task by its ID

#### 🔌 Usage

```typescript await client.task.get("task_id"); ```

#### ⚙️ Parameters

**taskId:** `string` — Task ID

**requestOptions:** `Task.RequestOptions`

## Thread

client.thread.listAll({ ...params }) -> Zep.ThreadListResponse

#### 📝 Description

Returns all threads.

#### 🔌 Usage

```typescript await client.thread.listAll({ pageNumber: 1, pageSize: 1, orderBy: "order_by", asc: true, }); ```

#### ⚙️ Parameters

**request:** `Zep.ThreadListAllRequest`

**requestOptions:** `Thread.RequestOptions`

client.thread.create({ ...params }) -> Zep.Thread

#### 📝 Description

Start a new thread.

#### 🔌 Usage

```typescript await client.thread.create({ threadId: "thread_id", userId: "user_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.CreateThreadRequest`

**requestOptions:** `Thread.RequestOptions`

client.thread.delete(threadId) -> Zep.SuccessResponse

#### 📝 Description

Deletes a thread.

#### 🔌 Usage

```typescript await client.thread.delete("threadId"); ```

#### ⚙️ Parameters

**threadId:** `string` — The ID of the thread for which memory should be deleted.

**requestOptions:** `Thread.RequestOptions`

client.thread.getUserContext(threadId, { ...params }) -> Zep.ThreadContextResponse

#### 📝 Description

Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.

#### 🔌 Usage

```typescript await client.thread.getUserContext("threadId", { templateId: "template_id", }); ```

#### ⚙️ Parameters

**threadId:** `string` — The ID of the current thread (for which context is being retrieved).

**request:** `Zep.ThreadGetUserContextRequest`

**requestOptions:** `Thread.RequestOptions`

client.thread.get(threadId, { ...params }) -> Zep.MessageListResponse

#### 📝 Description

Returns messages for a thread.

#### 🔌 Usage

```typescript await client.thread.get("threadId", { limit: 1, cursor: 1, lastn: 1, }); ```

#### ⚙️ Parameters

**threadId:** `string` — Thread ID

**request:** `Zep.ThreadGetRequest`

**requestOptions:** `Thread.RequestOptions`

client.thread.addMessages(threadId, { ...params }) -> Zep.AddThreadMessagesResponse

#### 📝 Description

Add messages to a thread.

#### 🔌 Usage

```typescript await client.thread.addMessages("threadId", { messages: [ { content: "content", role: "norole", }, ], }); ```

#### ⚙️ Parameters

**threadId:** `string` — The ID of the thread to which messages should be added.

**request:** `Zep.AddThreadMessagesRequest`

**requestOptions:** `Thread.RequestOptions`

client.thread.addMessagesBatch(threadId, { ...params }) -> Zep.AddThreadMessagesResponse

#### 📝 Description

Add messages to a thread in batch mode. This will process messages concurrently, which is useful for data migrations.

#### 🔌 Usage

```typescript await client.thread.addMessagesBatch("threadId", { messages: [ { content: "content", role: "norole", }, ], }); ```

#### ⚙️ Parameters

**threadId:** `string` — The ID of the thread to which messages should be added.

**request:** `Zep.AddThreadMessagesRequest`

**requestOptions:** `Thread.RequestOptions`

## User

client.user.listUserSummaryInstructions({ ...params }) -> Zep.ListUserInstructionsResponse

#### 📝 Description

Lists all user summary instructions for a project, user.

#### 🔌 Usage

```typescript await client.user.listUserSummaryInstructions({ userId: "user_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.UserListUserSummaryInstructionsRequest`

**requestOptions:** `User.RequestOptions`

client.user.addUserSummaryInstructions({ ...params }) -> Zep.SuccessResponse

#### 📝 Description

Adds new summary instructions for users graphs without removing existing ones. If user_ids is empty, adds to project-wide default instructions.

#### 🔌 Usage

```typescript await client.user.addUserSummaryInstructions({ instructions: [ { name: "name", text: "text", }, ], }); ```

#### ⚙️ Parameters

**request:** `Zep.AddUserInstructionsRequest`

**requestOptions:** `User.RequestOptions`

client.user.deleteUserSummaryInstructions({ ...params }) -> Zep.SuccessResponse

#### 📝 Description

Deletes user summary/instructions for users or project wide defaults.

#### 🔌 Usage

```typescript await client.user.deleteUserSummaryInstructions(); ```

#### ⚙️ Parameters

**request:** `Zep.DeleteUserInstructionsRequest`

**requestOptions:** `User.RequestOptions`

client.user.add({ ...params }) -> Zep.User

#### 📝 Description

Adds a user.

#### 🔌 Usage

```typescript await client.user.add({ userId: "user_id", }); ```

#### ⚙️ Parameters

**request:** `Zep.CreateUserRequest`

**requestOptions:** `User.RequestOptions`

client.user.listOrdered({ ...params }) -> Zep.UserListResponse

#### 📝 Description

Returns all users.

#### 🔌 Usage

```typescript await client.user.listOrdered({ pageNumber: 1, pageSize: 1, search: "search", orderBy: "order_by", asc: true, }); ```

#### ⚙️ Parameters

**request:** `Zep.UserListOrderedRequest`

**requestOptions:** `User.RequestOptions`

client.user.get(userId) -> Zep.User

#### 📝 Description

Returns a user.

#### 🔌 Usage

```typescript await client.user.get("userId"); ```

#### ⚙️ Parameters

**userId:** `string` — The user_id of the user to get.

**requestOptions:** `User.RequestOptions`

client.user.delete(userId) -> Zep.SuccessResponse

#### 📝 Description

Deletes a user.

#### 🔌 Usage

```typescript await client.user.delete("userId"); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**requestOptions:** `User.RequestOptions`

client.user.update(userId, { ...params }) -> Zep.User

#### 📝 Description

Updates a user.

#### 🔌 Usage

```typescript await client.user.update("userId"); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**request:** `Zep.UpdateUserRequest`

**requestOptions:** `User.RequestOptions`

client.user.getNode(userId) -> Zep.UserNodeResponse

#### 📝 Description

Returns a user's node.

#### 🔌 Usage

```typescript await client.user.getNode("userId"); ```

#### ⚙️ Parameters

**userId:** `string` — The user_id of the user to get the node for.

**requestOptions:** `User.RequestOptions`

client.user.getThreads(userId) -> Zep.Thread[]

#### 📝 Description

Returns all threads for a user.

#### 🔌 Usage

```typescript await client.user.getThreads("userId"); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**requestOptions:** `User.RequestOptions`

client.user.warm(userId) -> Zep.SuccessResponse

#### 📝 Description

Hints Zep to warm a user's graph for low-latency search

#### 🔌 Usage

```typescript await client.user.warm("userId"); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**requestOptions:** `User.RequestOptions`

## Graph Edge

client.graph.edge.getByGraphId(graphId, { ...params }) -> Zep.EntityEdge[]

#### 📝 Description

Returns all edges for a graph.

#### 🔌 Usage

```typescript await client.graph.edge.getByGraphId("graph_id", {}); ```

#### ⚙️ Parameters

**graphId:** `string` — Graph ID

**request:** `Zep.GraphEdgesRequest`

**requestOptions:** `Edge.RequestOptions`

client.graph.edge.getByUserId(userId, { ...params }) -> Zep.EntityEdge[]

#### 📝 Description

Returns all edges for a user.

#### 🔌 Usage

```typescript await client.graph.edge.getByUserId("user_id", {}); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**request:** `Zep.GraphEdgesRequest`

**requestOptions:** `Edge.RequestOptions`

client.graph.edge.get(uuid) -> Zep.EntityEdge

#### 📝 Description

Returns a specific edge by its UUID.

#### 🔌 Usage

```typescript await client.graph.edge.get("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Edge UUID

**requestOptions:** `Edge.RequestOptions`

client.graph.edge.delete(uuid) -> Zep.SuccessResponse

#### 📝 Description

Deletes an edge by UUID.

#### 🔌 Usage

```typescript await client.graph.edge.delete("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Edge UUID

**requestOptions:** `Edge.RequestOptions`

client.graph.edge.update(uuid, { ...params }) -> Zep.EntityEdge

#### 📝 Description

Updates an entity edge by UUID.

#### 🔌 Usage

```typescript await client.graph.edge.update("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Edge UUID

**request:** `Zep.graph.UpdateEdgeRequest`

**requestOptions:** `Edge.RequestOptions`

## Graph Episode

client.graph.episode.getByGraphId(graphId, { ...params }) -> Zep.EpisodeResponse

#### 📝 Description

Returns episodes by graph id.

#### 🔌 Usage

```typescript await client.graph.episode.getByGraphId("graph_id", { lastn: 1, }); ```

#### ⚙️ Parameters

**graphId:** `string` — Graph ID

**request:** `Zep.graph.EpisodeGetByGraphIdRequest`

**requestOptions:** `Episode.RequestOptions`

client.graph.episode.getByUserId(userId, { ...params }) -> Zep.EpisodeResponse

#### 📝 Description

Returns episodes by user id.

#### 🔌 Usage

```typescript await client.graph.episode.getByUserId("user_id", { lastn: 1, }); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**request:** `Zep.graph.EpisodeGetByUserIdRequest`

**requestOptions:** `Episode.RequestOptions`

client.graph.episode.get(uuid) -> Zep.Episode

#### 📝 Description

Returns episodes by UUID

#### 🔌 Usage

```typescript await client.graph.episode.get("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Episode UUID

**requestOptions:** `Episode.RequestOptions`

client.graph.episode.delete(uuid) -> Zep.SuccessResponse

#### 📝 Description

Deletes an episode by its UUID.

#### 🔌 Usage

```typescript await client.graph.episode.delete("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Episode UUID

**requestOptions:** `Episode.RequestOptions`

client.graph.episode.getNodesAndEdges(uuid) -> Zep.EpisodeMentions

#### 📝 Description

Returns nodes and edges mentioned in an episode

#### 🔌 Usage

```typescript await client.graph.episode.getNodesAndEdges("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Episode uuid

**requestOptions:** `Episode.RequestOptions`

## Graph Node

client.graph.node.getByGraphId(graphId, { ...params }) -> Zep.EntityNode[]

#### 📝 Description

Returns all nodes for a graph.

#### 🔌 Usage

```typescript await client.graph.node.getByGraphId("graph_id", {}); ```

#### ⚙️ Parameters

**graphId:** `string` — Graph ID

**request:** `Zep.GraphNodesRequest`

**requestOptions:** `Node.RequestOptions`

client.graph.node.getByUserId(userId, { ...params }) -> Zep.EntityNode[]

#### 📝 Description

Returns all nodes for a user

#### 🔌 Usage

```typescript await client.graph.node.getByUserId("user_id", {}); ```

#### ⚙️ Parameters

**userId:** `string` — User ID

**request:** `Zep.GraphNodesRequest`

**requestOptions:** `Node.RequestOptions`

client.graph.node.getEdges(nodeUuid) -> Zep.EntityEdge[]

#### 📝 Description

Returns all edges for a node

#### 🔌 Usage

```typescript await client.graph.node.getEdges("node_uuid"); ```

#### ⚙️ Parameters

**nodeUuid:** `string` — Node UUID

**requestOptions:** `Node.RequestOptions`

client.graph.node.getEpisodes(nodeUuid) -> Zep.EpisodeResponse

#### 📝 Description

Returns all episodes that mentioned a given node

#### 🔌 Usage

```typescript await client.graph.node.getEpisodes("node_uuid"); ```

#### ⚙️ Parameters

**nodeUuid:** `string` — Node UUID

**requestOptions:** `Node.RequestOptions`

client.graph.node.get(uuid) -> Zep.EntityNode

#### 📝 Description

Returns a specific node by its UUID.

#### 🔌 Usage

```typescript await client.graph.node.get("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Node UUID

**requestOptions:** `Node.RequestOptions`

client.graph.node.delete(uuid) -> Zep.SuccessResponse

#### 📝 Description

Deletes a node by UUID.

#### 🔌 Usage

```typescript await client.graph.node.delete("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Node UUID

**requestOptions:** `Node.RequestOptions`

client.graph.node.update(uuid, { ...params }) -> Zep.EntityNode

#### 📝 Description

Updates an entity node by UUID.

#### 🔌 Usage

```typescript await client.graph.node.update("uuid"); ```

#### ⚙️ Parameters

**uuid:** `string` — Node UUID

**request:** `Zep.graph.UpdateNodeRequest`

**requestOptions:** `Node.RequestOptions`

## Thread Message

client.thread.message.update(messageUuid, { ...params }) -> Zep.Message

#### 📝 Description

Updates a message.

#### 🔌 Usage

```typescript await client.thread.message.update("messageUUID", { metadata: { key: "value", }, }); ```

#### ⚙️ Parameters

**messageUuid:** `string` — The UUID of the message.

**request:** `Zep.thread.ThreadMessageUpdate`

**requestOptions:** `Message.RequestOptions`