/zep-graph | Type: Application | PCID required: Yes
Tools
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. |
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. |
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. |
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 |
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. |
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). |
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 |
zep_graph_delete_context_template
Delete Context Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | 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. |
zep_graph_delete_edge
Delete Edge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | Edge UUID |
zep_graph_delete_episode
Delete Episode Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | Episode UUID |
zep_graph_delete_graph
Delete Graph Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
graphId | string | Yes | — | Graph ID |
zep_graph_delete_node
Delete Node Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | Node 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 |
zep_graph_get_context_template
Get Context Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | Template ID |
zep_graph_get_edge
Get Edge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | Edge 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 |
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 |
zep_graph_get_episode
Get Episode Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | Episode 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. |
zep_graph_get_episodes_for_a_node
Get Episodes for a node Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
node_uuid | string | Yes | — | 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. |
zep_graph_get_node
Get Node Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | Node 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 |
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 |
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. |
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 |
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. |
zep_graph_list_context_templates
List Context Templateszep_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 |
zep_graph_list_ontology
List graph ontologyzep_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 |
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. |
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 |
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). |
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 |
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. |
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 |
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 |

