> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# zep-graph
> Zep Graph - knowledge graph, nodes, edges, episodes, and search
**Server path:** `/zep-graph` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| [`zep_graph_add_custom_instructions`](#zep_graph_add_custom_instructions) | Add Custom Instructions |
| [`zep_graph_add_data`](#zep_graph_add_data) | Add Data |
| [`zep_graph_add_data_in_batch_mode`](#zep_graph_add_data_in_batch_mode) | Add Data in batch mode |
| [`zep_graph_add_fact_triple`](#zep_graph_add_fact_triple) | Add Fact Triple |
| [`zep_graph_clone_graph`](#zep_graph_clone_graph) | Clone graph |
| [`zep_graph_create_context_template`](#zep_graph_create_context_template) | Create Context Template |
| [`zep_graph_create_graph`](#zep_graph_create_graph) | Create Graph |
| [`zep_graph_delete_context_template`](#zep_graph_delete_context_template) | Delete Context Template |
| [`zep_graph_delete_custom_instructions`](#zep_graph_delete_custom_instructions) | Delete Custom Instructions |
| [`zep_graph_delete_edge`](#zep_graph_delete_edge) | Delete Edge |
| [`zep_graph_delete_episode`](#zep_graph_delete_episode) | Delete Episode |
| [`zep_graph_delete_graph`](#zep_graph_delete_graph) | Delete Graph |
| [`zep_graph_delete_node`](#zep_graph_delete_node) | Delete Node |
| [`zep_graph_detect_patterns_experimental`](#zep_graph_detect_patterns_experimental) | Detect Patterns (Experimental) |
| [`zep_graph_get_context_template`](#zep_graph_get_context_template) | Get Context Template |
| [`zep_graph_get_edge`](#zep_graph_get_edge) | Get Edge |
| [`zep_graph_get_edges`](#zep_graph_get_edges) | Get Graph Edges |
| [`zep_graph_get_entity_edges_for_a_node`](#zep_graph_get_entity_edges_for_a_node) | Get Entity Edges for a node |
| [`zep_graph_get_episode`](#zep_graph_get_episode) | Get Episode |
| [`zep_graph_get_episodes`](#zep_graph_get_episodes) | Get Graph Episodes |
| [`zep_graph_get_episodes_for_a_node`](#zep_graph_get_episodes_for_a_node) | Get Episodes for a node |
| [`zep_graph_get_graph`](#zep_graph_get_graph) | Get Graph |
| [`zep_graph_get_node`](#zep_graph_get_node) | Get Node |
| [`zep_graph_get_nodes`](#zep_graph_get_nodes) | Get Graph Nodes |
| [`zep_graph_get_user_edges`](#zep_graph_get_user_edges) | Get User Edges |
| [`zep_graph_get_user_episodes`](#zep_graph_get_user_episodes) | Get User Episodes |
| [`zep_graph_get_user_nodes`](#zep_graph_get_user_nodes) | Get User Nodes |
| [`zep_graph_list_all_graphs`](#zep_graph_list_all_graphs) | List all graphs. |
| [`zep_graph_list_context_templates`](#zep_graph_list_context_templates) | List Context Templates |
| [`zep_graph_list_custom_instructions`](#zep_graph_list_custom_instructions) | List Custom Instructions |
| [`zep_graph_list_ontology`](#zep_graph_list_ontology) | List graph ontology |
| [`zep_graph_return_any_nodes_and_edges_mentioned_in_an_episode`](#zep_graph_return_any_nodes_and_edges_mentioned_in_an_episode) | Return any nodes and edges mentioned in an episode |
| [`zep_graph_search_graph`](#zep_graph_search_graph) | Search Graph |
| [`zep_graph_set_ontology`](#zep_graph_set_ontology) | Set graph ontology |
| [`zep_graph_update_context_template`](#zep_graph_update_context_template) | Update Context Template |
| [`zep_graph_update_edge`](#zep_graph_update_edge) | Update Edge |
| [`zep_graph_update_episode_metadata`](#zep_graph_update_episode_metadata) | Update Episode Metadata |
| [`zep_graph_update_graph`](#zep_graph_update_graph) | Update Graph. |
| [`zep_graph_update_node`](#zep_graph_update_node) | Update Node |
***
## zep\_graph\_add\_custom\_instructions
Add Custom Instructions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `graph_ids` | string\[] | No | — | Graph IDs to add the instructions to. If empty, the instructions are added to the project-wide default. |
| `instructions` | object\[] | Yes | — | Instructions to add to the graph. |
| `user_ids` | string\[] | No | — | User IDs to add the instructions to. If empty, the instructions are added to the project-wide default. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graph_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Graph IDs to add the instructions to. If empty, the instructions are added to the project-wide default."
},
"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 graph."
},
"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\_graph\_add\_data
Add Data
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `created_at` | string | No | — | Created At |
| `data` | string | Yes | — | The data value |
| `graph_id` | string | No | — | graph\_id is the ID of the graph to which the data will be added. If adding to the user graph, please use user\_id field instead. |
| `metadata` | object | No | — | Optional metadata key-value pairs. Max 10 keys. Values must be strings, numbers, booleans, or arrays of scalars. |
| `source_description` | string | No | — | Source Description |
| `type` | string | Yes | — | The type value |
| `user_id` | string | No | — | User ID is the ID of the user to which the data will be added. If not adding to a user graph, please use graph\_id field instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_at": {
"type": "string",
"description": "Created At"
},
"data": {
"type": "string",
"description": "The data value"
},
"graph_id": {
"type": "string",
"description": "graph_id is the ID of the graph to which the data will be added. If adding to the user graph, please use user_id field instead."
},
"metadata": {
"type": "object",
"description": "Optional metadata key-value pairs. Max 10 keys. Values must be strings, numbers, booleans, or arrays of scalars."
},
"source_description": {
"type": "string",
"description": "Source Description"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"text",
"json",
"message"
]
},
"user_id": {
"type": "string",
"description": "User ID is the ID of the user to which the data will be added. If not adding to a user graph, please use graph_id field instead."
}
},
"required": [
"PCID",
"data",
"type"
]
}
```
***
## zep\_graph\_add\_data\_in\_batch\_mode
Add Data in batch mode
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `episodes` | object\[] | Yes | — | The episodes value |
| `graph_id` | string | No | — | graph\_id is the ID of the graph to which the data will be added. If adding to the user graph, please use user\_id field instead. |
| `user_id` | string | No | — | User ID is the ID of the user to which the data will be added. If not adding to a user graph, please use graph\_id field instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"episodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "Created At"
},
"data": {
"type": "string",
"description": "The data value"
},
"source_description": {
"type": "string",
"description": "Source Description"
},
"type": {
"type": "string",
"enum": [
"text",
"json",
"message"
],
"description": "The type value"
},
"metadata": {
"type": "object",
"description": "Optional metadata key-value pairs. Max 10 keys. Values must be strings, numbers, booleans, or arrays of scalars."
}
},
"required": [
"data",
"type"
]
},
"description": "The episodes value"
},
"graph_id": {
"type": "string",
"description": "graph_id is the ID of the graph to which the data will be added. If adding to the user graph, please use user_id field instead."
},
"user_id": {
"type": "string",
"description": "User ID is the ID of the user to which the data will be added. If not adding to a user graph, please use graph_id field instead."
}
},
"required": [
"PCID",
"episodes"
]
}
```
***
## zep\_graph\_add\_fact\_triple
Add Fact Triple
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `created_at` | string | No | — | The timestamp of the message |
| `edge_attributes` | object | No | — | Additional attributes of the edge. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed. |
| `expired_at` | string | No | — | The time (if any) at which the edge expires |
| `fact` | string | Yes | — | The fact relating the two nodes that this edge represents |
| `fact_name` | string | Yes | — | The name of the edge to add. Should be all caps using snake case (eg RELATES\_TO) |
| `fact_uuid` | string | No | — | The uuid of the edge to add |
| `graph_id` | string | No | — | Graph Id |
| `invalid_at` | string | No | — | The time (if any) at which the fact stops being true |
| `metadata` | object | No | — | Optional metadata key-value pairs for the shadow episode created for this fact triple. Max 10 keys. Values must be strings, numbers, or booleans. |
| `source_node_attributes` | object | No | — | Additional attributes of the source node. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed. |
| `source_node_labels` | string\[] | No | — | The labels for the source node |
| `source_node_name` | string | No | — | The name of the source node to add |
| `source_node_summary` | string | No | — | The summary of the source node to add |
| `source_node_uuid` | string | No | — | The source node uuid |
| `target_node_attributes` | object | No | — | Additional attributes of the target node. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed. |
| `target_node_labels` | string\[] | No | — | The labels for the target node |
| `target_node_name` | string | No | — | The name of the target node to add |
| `target_node_summary` | string | No | — | The summary of the target node to add |
| `target_node_uuid` | string | No | — | The target node uuid |
| `user_id` | string | No | — | User Id |
| `valid_at` | string | No | — | The time at which the fact becomes true |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_at": {
"type": "string",
"description": "The timestamp of the message"
},
"edge_attributes": {
"type": "object",
"description": "Additional attributes of the edge. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed."
},
"expired_at": {
"type": "string",
"description": "The time (if any) at which the edge expires"
},
"fact": {
"type": "string",
"description": "The fact relating the two nodes that this edge represents"
},
"fact_name": {
"type": "string",
"description": "The name of the edge to add. Should be all caps using snake case (eg RELATES_TO)"
},
"fact_uuid": {
"type": "string",
"description": "The uuid of the edge to add"
},
"graph_id": {
"type": "string",
"description": "Graph Id"
},
"invalid_at": {
"type": "string",
"description": "The time (if any) at which the fact stops being true"
},
"metadata": {
"type": "object",
"description": "Optional metadata key-value pairs for the shadow episode created for this fact triple. Max 10 keys. Values must be strings, numbers, or booleans."
},
"source_node_attributes": {
"type": "object",
"description": "Additional attributes of the source node. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed."
},
"source_node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The labels for the source node"
},
"source_node_name": {
"type": "string",
"description": "The name of the source node to add"
},
"source_node_summary": {
"type": "string",
"description": "The summary of the source node to add"
},
"source_node_uuid": {
"type": "string",
"description": "The source node uuid"
},
"target_node_attributes": {
"type": "object",
"description": "Additional attributes of the target node. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed."
},
"target_node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The labels for the target node"
},
"target_node_name": {
"type": "string",
"description": "The name of the target node to add"
},
"target_node_summary": {
"type": "string",
"description": "The summary of the target node to add"
},
"target_node_uuid": {
"type": "string",
"description": "The target node uuid"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"valid_at": {
"type": "string",
"description": "The time at which the fact becomes true"
}
},
"required": [
"PCID",
"fact",
"fact_name"
]
}
```
***
## zep\_graph\_clone\_graph
Clone graph
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `source_graph_id` | string | No | — | source\_graph\_id is the ID of the graph to be cloned. Required if source\_user\_id is not provided |
| `source_user_id` | string | No | — | user\_id of the user whose graph is being cloned. Required if source\_graph\_id is not provided |
| `target_graph_id` | string | No | — | target\_graph\_id is the ID to be set on the cloned graph. Must not point to an existing graph. Required if target\_user\_id is not provided. |
| `target_user_id` | string | No | — | user\_id to be set on the cloned user. Must not point to an existing user. Required if target\_graph\_id is not provided. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_graph_id": {
"type": "string",
"description": "source_graph_id is the ID of the graph to be cloned. Required if source_user_id is not provided"
},
"source_user_id": {
"type": "string",
"description": "user_id of the user whose graph is being cloned. Required if source_graph_id is not provided"
},
"target_graph_id": {
"type": "string",
"description": "target_graph_id is the ID to be set on the cloned graph. Must not point to an existing graph. Required if target_user_id is not provided."
},
"target_user_id": {
"type": "string",
"description": "user_id to be set on the cloned user. Must not point to an existing user. Required if target_graph_id is not provided."
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_create\_context\_template
Create Context Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `template` | string | Yes | — | The template content (max 1200 characters). |
| `template_id` | string | Yes | — | Unique identifier for the template (max 100 characters). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"template": {
"type": "string",
"description": "The template content (max 1200 characters)."
},
"template_id": {
"type": "string",
"description": "Unique identifier for the template (max 100 characters)."
}
},
"required": [
"PCID",
"template",
"template_id"
]
}
```
***
## zep\_graph\_create\_graph
Create Graph
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------- |
| `description` | string | No | — | The description value |
| `graph_id` | string | Yes | — | Graph Id |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "The description value"
},
"graph_id": {
"type": "string",
"description": "Graph Id"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"graph_id"
]
}
```
***
## zep\_graph\_delete\_context\_template
Delete Context Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `template_id` | string | Yes | — | Template ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"template_id": {
"type": "string",
"description": "Template ID"
}
},
"required": [
"PCID",
"template_id"
]
}
```
***
## zep\_graph\_delete\_custom\_instructions
Delete Custom Instructions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `graph_ids` | string\[] | No | — | Determines which group graphs will have their custom instructions deleted. If no graphs are provided, the project-wide custom instructions will be affected. |
| `instruction_names` | string\[] | No | — | Unique identifier for the instructions to be deleted. If empty deletes all instructions. |
| `user_ids` | string\[] | No | — | Determines which user graphs will have their custom instructions deleted. If no users are provided, the project-wide custom instructions will be affected. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graph_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Determines which group graphs will have their custom instructions deleted. If no graphs are provided, the project-wide custom instructions will be affected."
},
"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 user graphs will have their custom instructions deleted. If no users are provided, the project-wide custom instructions will be affected."
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_delete\_edge
Delete Edge
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `uuid` | string | Yes | — | Edge UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Edge UUID"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_delete\_episode
Delete Episode
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `uuid` | string | Yes | — | Episode UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Episode UUID"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_delete\_graph
Delete Graph
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `graphId` | string | Yes | — | Graph ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graphId": {
"type": "string",
"description": "Graph ID"
}
},
"required": [
"PCID",
"graphId"
]
}
```
***
## zep\_graph\_delete\_node
Delete Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `uuid` | string | Yes | — | Node UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Node UUID"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_detect\_patterns\_experimental
Detect Patterns (Experimental)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `detect` | object | No | — | The detect value |
| `edge_limit` | integer | No | — | Max resolved edges per pattern. Default: 10, Max: 100. Only used with query. |
| `graph_id` | string | No | — | Graph ID when detecting patterns on a named graph |
| `limit` | integer | No | — | Max patterns to return. Default: 50, Max: 200 |
| `min_occurrences` | integer | No | — | Minimum occurrence count to report a pattern. Default: 2 |
| `query` | string | No | — | Search query for discovering seed nodes via hybrid search. When set, forces triple-frequency detection only and enables edge resolution with cross-encoder reranking. Mutually exclusive with seeds. |
| `query_limit` | integer | No | — | Max seed nodes from search. Default: 10, Max: 50. Only used with query. |
| `recency_weight` | string | No | — | Recency Weight |
| `search_filters` | object | No | — | Search Filters |
| `seeds` | object | No | — | The seeds value |
| `user_id` | string | No | — | User ID when detecting patterns on a user graph |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"detect": {
"type": "object",
"description": "The detect value",
"properties": {
"clusters": {
"type": "object",
"description": "The clusters value"
},
"co_occurrences": {
"type": "object",
"description": "Co Occurrences"
},
"hubs": {
"type": "object",
"description": "The hubs value"
},
"paths": {
"type": "object",
"description": "The paths value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
}
},
"edge_limit": {
"type": "integer",
"description": "Max resolved edges per pattern. Default: 10, Max: 100. Only used with query."
},
"graph_id": {
"type": "string",
"description": "Graph ID when detecting patterns on a named graph"
},
"limit": {
"type": "integer",
"description": "Max patterns to return. Default: 50, Max: 200"
},
"min_occurrences": {
"type": "integer",
"description": "Minimum occurrence count to report a pattern. Default: 2"
},
"query": {
"type": "string",
"description": "Search query for discovering seed nodes via hybrid search. When set, forces triple-frequency detection only and enables edge resolution with cross-encoder reranking. Mutually exclusive with seeds."
},
"query_limit": {
"type": "integer",
"description": "Max seed nodes from search. Default: 10, Max: 50. Only used with query."
},
"recency_weight": {
"type": "string",
"description": "Recency Weight",
"enum": [
"none",
"7_days",
"30_days",
"90_days"
]
},
"search_filters": {
"type": "object",
"description": "Search Filters",
"properties": {
"created_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the created_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (created_at \\> date1 AND created_at \\< date2) OR (created_at = date3)"
},
"edge_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of edge types to filter on"
},
"edge_uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of edge UUIDs to filter on"
},
"exclude_edge_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of edge types to exclude from results"
},
"exclude_node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of node labels to exclude from results"
},
"expired_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the expired_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (expired_at \\> date1 AND expired_at \\< date2) OR (expired_at = date3)"
},
"invalid_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the invalid_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (invalid_at \\> date1 AND invalid_at \\< date2) OR (invalid_at = date3)"
},
"node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of node labels to filter on"
},
"property_filters": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of property filters to apply to nodes and edges"
},
"valid_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the valid_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (valid_at \\> date1 AND valid_at \\< date2) OR (valid_at = date3)"
},
"episode_metadata_filters": {
"type": "object",
"description": "Episode Metadata Filters"
}
}
},
"seeds": {
"type": "object",
"description": "The seeds value",
"properties": {
"edge_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "All endpoints of these edge types become seeds"
},
"node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "All nodes with these labels become seeds"
},
"node_uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific node UUIDs to analyze around"
}
}
},
"user_id": {
"type": "string",
"description": "User ID when detecting patterns on a user graph"
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_get\_context\_template
Get Context Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `template_id` | string | Yes | — | Template ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"template_id": {
"type": "string",
"description": "Template ID"
}
},
"required": [
"PCID",
"template_id"
]
}
```
***
## zep\_graph\_get\_edge
Get Edge
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `uuid` | string | Yes | — | Edge UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Edge UUID"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_get\_edges
Get Graph Edges
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `graph_id` | string | Yes | — | Graph ID |
| `limit` | integer | No | — | Maximum number of items to return |
| `uuid_cursor` | string | No | — | UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graph_id": {
"type": "string",
"description": "Graph ID"
},
"limit": {
"type": "integer",
"description": "Maximum number of items to return"
},
"uuid_cursor": {
"type": "string",
"description": "UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page"
}
},
"required": [
"PCID",
"graph_id"
]
}
```
***
## zep\_graph\_get\_entity\_edges\_for\_a\_node
Get Entity Edges for a node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `node_uuid` | string | Yes | — | Node UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"node_uuid": {
"type": "string",
"description": "Node UUID"
}
},
"required": [
"PCID",
"node_uuid"
]
}
```
***
## zep\_graph\_get\_episode
Get Episode
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `uuid` | string | Yes | — | Episode UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Episode UUID"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_get\_episodes
Get Graph Episodes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ----------------------------------------------- |
| `graph_id` | string | Yes | — | Graph ID |
| `lastn` | integer | No | — | The number of most recent episodes to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graph_id": {
"type": "string",
"description": "Graph ID"
},
"lastn": {
"type": "integer",
"description": "The number of most recent episodes to retrieve."
}
},
"required": [
"PCID",
"graph_id"
]
}
```
***
## zep\_graph\_get\_episodes\_for\_a\_node
Get Episodes for a node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `node_uuid` | string | Yes | — | Node UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"node_uuid": {
"type": "string",
"description": "Node UUID"
}
},
"required": [
"PCID",
"node_uuid"
]
}
```
***
## zep\_graph\_get\_graph
Get Graph
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------- |
| `graphId` | string | Yes | — | The graph\_id of the graph to get. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graphId": {
"type": "string",
"description": "The graph_id of the graph to get."
}
},
"required": [
"PCID",
"graphId"
]
}
```
***
## zep\_graph\_get\_node
Get Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `uuid` | string | Yes | — | Node UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Node UUID"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_get\_nodes
Get Graph Nodes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `graph_id` | string | Yes | — | Graph ID |
| `limit` | integer | No | — | Maximum number of items to return |
| `uuid_cursor` | string | No | — | UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graph_id": {
"type": "string",
"description": "Graph ID"
},
"limit": {
"type": "integer",
"description": "Maximum number of items to return"
},
"uuid_cursor": {
"type": "string",
"description": "UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page"
}
},
"required": [
"PCID",
"graph_id"
]
}
```
***
## zep\_graph\_get\_user\_edges
Get User Edges
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `user_id` | string | Yes | — | User ID |
| `limit` | integer | No | — | Maximum number of items to return |
| `uuid_cursor` | string | No | — | UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID"
},
"limit": {
"type": "integer",
"description": "Maximum number of items to return"
},
"uuid_cursor": {
"type": "string",
"description": "UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page"
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## zep\_graph\_get\_user\_episodes
Get User Episodes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `user_id` | string | Yes | — | User ID |
| `lastn` | integer | No | — | The number of most recent episodes entries to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID"
},
"lastn": {
"type": "integer",
"description": "The number of most recent episodes entries to retrieve."
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## zep\_graph\_get\_user\_nodes
Get User Nodes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `user_id` | string | Yes | — | User ID |
| `limit` | integer | No | — | Maximum number of items to return |
| `uuid_cursor` | string | No | — | UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID"
},
"limit": {
"type": "integer",
"description": "Maximum number of items to return"
},
"uuid_cursor": {
"type": "string",
"description": "UUID based cursor, used for pagination. Should be the UUID of the last item in the previous page"
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## zep\_graph\_list\_all\_graphs
List all graphs.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------- |
| `pageNumber` | integer | No | — | Page number for pagination, starting from 1. |
| `pageSize` | integer | No | — | Number of graphs to retrieve per page. |
| `search` | string | No | — | Search term for filtering graphs by graph\_id. |
| `order_by` | string | No | — | Column to sort by (created\_at, group\_id, name). |
| `asc` | boolean | No | — | Sort in ascending order. |
```json theme={null}
{
"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 graphs to retrieve per page."
},
"search": {
"type": "string",
"description": "Search term for filtering graphs by graph_id."
},
"order_by": {
"type": "string",
"description": "Column to sort by (created_at, group_id, name)."
},
"asc": {
"type": "boolean",
"description": "Sort in ascending order."
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_list\_context\_templates
List Context Templates
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_list\_custom\_instructions
List Custom Instructions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------- |
| `user_id` | string | No | — | User ID to get user-specific instructions |
| `graph_id` | string | No | — | Graph ID to get graph-specific instructions |
```json theme={null}
{
"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"
},
"graph_id": {
"type": "string",
"description": "Graph ID to get graph-specific instructions"
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_list\_ontology
List graph ontology
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_return\_any\_nodes\_and\_edges\_mentioned\_in\_an\_episode
Return any nodes and edges mentioned in an episode
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `uuid` | string | Yes | — | Episode uuid |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Episode uuid"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_search\_graph
Search Graph
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------- |
| `bfs_origin_node_uuids` | string\[] | No | — | Nodes that are the origins of the BFS searches |
| `center_node_uuid` | string | No | — | Node to rerank around for node distance reranking |
| `graph_id` | string | No | — | The graph\_id to search in. When searching user graph, please use user\_id instead. |
| `limit` | integer | No | — | The maximum number of facts to retrieve. Defaults to 10. Limited to 50. |
| `mmr_lambda` | number | No | — | weighting for maximal marginal relevance |
| `query` | string | Yes | — | The string to search for (required) |
| `reranker` | string | No | — | The reranker value |
| `scope` | string | No | — | The scope value |
| `search_filters` | object | No | — | Search Filters |
| `user_id` | string | No | — | The user\_id when searching user graph. If not searching user graph, please use graph\_id instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"bfs_origin_node_uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Nodes that are the origins of the BFS searches"
},
"center_node_uuid": {
"type": "string",
"description": "Node to rerank around for node distance reranking"
},
"graph_id": {
"type": "string",
"description": "The graph_id to search in. When searching user graph, please use user_id instead."
},
"limit": {
"type": "integer",
"description": "The maximum number of facts to retrieve. Defaults to 10. Limited to 50."
},
"mmr_lambda": {
"type": "number",
"description": "weighting for maximal marginal relevance"
},
"query": {
"type": "string",
"description": "The string to search for (required)"
},
"reranker": {
"type": "string",
"description": "The reranker value",
"enum": [
"rrf",
"mmr",
"node_distance",
"episode_mentions",
"cross_encoder"
]
},
"scope": {
"type": "string",
"description": "The scope value",
"enum": [
"edges",
"nodes",
"episodes",
"communities"
]
},
"search_filters": {
"type": "object",
"description": "Search Filters",
"properties": {
"created_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the created_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (created_at \\> date1 AND created_at \\< date2) OR (created_at = date3)"
},
"edge_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of edge types to filter on"
},
"edge_uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of edge UUIDs to filter on"
},
"exclude_edge_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of edge types to exclude from results"
},
"exclude_node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of node labels to exclude from results"
},
"expired_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the expired_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (expired_at \\> date1 AND expired_at \\< date2) OR (expired_at = date3)"
},
"invalid_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the invalid_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (invalid_at \\> date1 AND invalid_at \\< date2) OR (invalid_at = date3)"
},
"node_labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of node labels to filter on"
},
"property_filters": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of property filters to apply to nodes and edges"
},
"valid_at": {
"type": "array",
"items": {
"type": "array"
},
"description": "2D array of date filters for the valid_at field. The outer array elements are combined with OR logic. The inner array elements are combined with AND logic. Example: [[\\{\"\\>\", date1\\}, \\{\"\\<\", date2\\}], [\\{\"=\", date3\\}]] This translates to: (valid_at \\> date1 AND valid_at \\< date2) OR (valid_at = date3)"
},
"episode_metadata_filters": {
"type": "object",
"description": "Episode Metadata Filters"
}
}
},
"user_id": {
"type": "string",
"description": "The user_id when searching user graph. If not searching user graph, please use graph_id instead."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## zep\_graph\_set\_ontology
Set graph ontology
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------- |
| `edges` | object | No | — | Dictionary mapping edge type names to their definitions with source/target constraints |
| `entities` | object | No | — | Dictionary mapping entity type names to their definitions |
| `graph_ids` | string\[] | No | — | Optional list of graph IDs to apply ontology to |
| `user_ids` | string\[] | No | — | Optional list of user IDs to apply ontology to |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"edges": {
"type": "object",
"description": "Dictionary mapping edge type names to their definitions with source/target constraints"
},
"entities": {
"type": "object",
"description": "Dictionary mapping entity type names to their definitions"
},
"graph_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of graph IDs to apply ontology to"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of user IDs to apply ontology to"
}
},
"required": [
"PCID"
]
}
```
***
## zep\_graph\_update\_context\_template
Update Context Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------- |
| `template_id` | string | Yes | — | Template ID |
| `template` | string | Yes | — | The template content (max 1200 characters). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"template_id": {
"type": "string",
"description": "Template ID"
},
"template": {
"type": "string",
"description": "The template content (max 1200 characters)."
}
},
"required": [
"PCID",
"template_id",
"template"
]
}
```
***
## zep\_graph\_update\_edge
Update Edge
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------ |
| `uuid` | string | Yes | — | Edge UUID |
| `attributes` | object | No | — | Updated attributes. Merged with existing attributes. Set a key to null to delete it. |
| `expired_at` | string | No | — | Updated time at which the edge expires |
| `fact` | string | No | — | Updated fact for the edge |
| `invalid_at` | string | No | — | Updated time at which the fact stopped being true |
| `name` | string | No | — | Updated name (relationship type) for the edge |
| `valid_at` | string | No | — | Updated time at which the fact becomes true |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Edge UUID"
},
"attributes": {
"type": "object",
"description": "Updated attributes. Merged with existing attributes. Set a key to null to delete it."
},
"expired_at": {
"type": "string",
"description": "Updated time at which the edge expires"
},
"fact": {
"type": "string",
"description": "Updated fact for the edge"
},
"invalid_at": {
"type": "string",
"description": "Updated time at which the fact stopped being true"
},
"name": {
"type": "string",
"description": "Updated name (relationship type) for the edge"
},
"valid_at": {
"type": "string",
"description": "Updated time at which the fact becomes true"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## zep\_graph\_update\_episode\_metadata
Update Episode Metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `uuid` | string | Yes | — | Episode UUID |
| `metadata` | object | Yes | — | Updated metadata. Merged with existing metadata: supplied keys overwrite/add, keys set to null are removed. Maximum 10 keys. Values must be scalars (string, number, boolean, null) or arrays of scalars. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Episode UUID"
},
"metadata": {
"type": "object",
"description": "Updated metadata. Merged with existing metadata: supplied keys overwrite/add, keys set to null are removed. Maximum 10 keys. Values must be scalars (string, number, boolean, null) or arrays of scalars."
}
},
"required": [
"PCID",
"uuid",
"metadata"
]
}
```
***
## zep\_graph\_update\_graph
Update Graph.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------- |
| `graphId` | string | Yes | — | Graph ID |
| `description` | string | No | — | The description value |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"graphId": {
"type": "string",
"description": "Graph ID"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"graphId"
]
}
```
***
## zep\_graph\_update\_node
Update Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------ |
| `uuid` | string | Yes | — | Node UUID |
| `attributes` | object | No | — | Updated attributes. Merged with existing attributes. Set a key to null to delete it. |
| `labels` | string\[] | No | — | Updated labels for the node |
| `name` | string | No | — | Updated name for the node |
| `summary` | string | No | — | Updated summary for the node |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "Node UUID"
},
"attributes": {
"type": "object",
"description": "Updated attributes. Merged with existing attributes. Set a key to null to delete it."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Updated labels for the node"
},
"name": {
"type": "string",
"description": "Updated name for the node"
},
"summary": {
"type": "string",
"description": "Updated summary for the node"
}
},
"required": [
"PCID",
"uuid"
]
}
```