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

Tools

ToolDescription
zep_graph_add_custom_instructionsAdd Custom Instructions
zep_graph_add_dataAdd Data
zep_graph_add_data_in_batch_modeAdd Data in batch mode
zep_graph_add_fact_tripleAdd Fact Triple
zep_graph_clone_graphClone graph
zep_graph_create_context_templateCreate Context Template
zep_graph_create_graphCreate Graph
zep_graph_delete_context_templateDelete Context Template
zep_graph_delete_custom_instructionsDelete Custom Instructions
zep_graph_delete_edgeDelete Edge
zep_graph_delete_episodeDelete Episode
zep_graph_delete_graphDelete Graph
zep_graph_delete_nodeDelete Node
zep_graph_detect_patterns_experimentalDetect Patterns (Experimental)
zep_graph_get_context_templateGet Context Template
zep_graph_get_edgeGet Edge
zep_graph_get_edgesGet Graph Edges
zep_graph_get_entity_edges_for_a_nodeGet Entity Edges for a node
zep_graph_get_episodeGet Episode
zep_graph_get_episodesGet Graph Episodes
zep_graph_get_episodes_for_a_nodeGet Episodes for a node
zep_graph_get_graphGet Graph
zep_graph_get_nodeGet Node
zep_graph_get_nodesGet Graph Nodes
zep_graph_get_user_edgesGet User Edges
zep_graph_get_user_episodesGet User Episodes
zep_graph_get_user_nodesGet User Nodes
zep_graph_list_all_graphsList all graphs.
zep_graph_list_context_templatesList Context Templates
zep_graph_list_custom_instructionsList Custom Instructions
zep_graph_list_ontologyList graph ontology
zep_graph_return_any_nodes_and_edges_mentioned_in_an_episodeReturn any nodes and edges mentioned in an episode
zep_graph_search_graphSearch Graph
zep_graph_set_ontologySet graph ontology
zep_graph_update_context_templateUpdate Context Template
zep_graph_update_edgeUpdate Edge
zep_graph_update_episode_metadataUpdate Episode Metadata
zep_graph_update_graphUpdate Graph.
zep_graph_update_nodeUpdate Node

zep_graph_add_custom_instructions

Add Custom Instructions Parameters:
ParameterTypeRequiredDefaultDescription
graph_idsstring[]NoGraph IDs to add the instructions to. If empty, the instructions are added to the project-wide default.
instructionsobject[]YesInstructions to add to the graph.
user_idsstring[]NoUser IDs to add the instructions to. If empty, the instructions are added to the project-wide default.

zep_graph_add_data

Add Data Parameters:
ParameterTypeRequiredDefaultDescription
created_atstringNoCreated At
datastringYesThe data value
graph_idstringNograph_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.
metadataobjectNoOptional metadata key-value pairs. Max 10 keys. Values must be strings, numbers, booleans, or arrays of scalars.
source_descriptionstringNoSource Description
typestringYesThe type value
user_idstringNoUser 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:
ParameterTypeRequiredDefaultDescription
episodesobject[]YesThe episodes value
graph_idstringNograph_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_idstringNoUser 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:
ParameterTypeRequiredDefaultDescription
created_atstringNoThe timestamp of the message
edge_attributesobjectNoAdditional attributes of the edge. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed.
expired_atstringNoThe time (if any) at which the edge expires
factstringYesThe fact relating the two nodes that this edge represents
fact_namestringYesThe name of the edge to add. Should be all caps using snake case (eg RELATES_TO)
fact_uuidstringNoThe uuid of the edge to add
graph_idstringNoGraph Id
invalid_atstringNoThe time (if any) at which the fact stops being true
metadataobjectNoOptional 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_attributesobjectNoAdditional attributes of the source node. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed.
source_node_labelsstring[]NoThe labels for the source node
source_node_namestringNoThe name of the source node to add
source_node_summarystringNoThe summary of the source node to add
source_node_uuidstringNoThe source node uuid
target_node_attributesobjectNoAdditional attributes of the target node. Values must be scalar types (string, number, boolean, or null). Nested objects and arrays are not allowed.
target_node_labelsstring[]NoThe labels for the target node
target_node_namestringNoThe name of the target node to add
target_node_summarystringNoThe summary of the target node to add
target_node_uuidstringNoThe target node uuid
user_idstringNoUser Id
valid_atstringNoThe time at which the fact becomes true

zep_graph_clone_graph

Clone graph Parameters:
ParameterTypeRequiredDefaultDescription
source_graph_idstringNosource_graph_id is the ID of the graph to be cloned. Required if source_user_id is not provided
source_user_idstringNouser_id of the user whose graph is being cloned. Required if source_graph_id is not provided
target_graph_idstringNotarget_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_idstringNouser_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:
ParameterTypeRequiredDefaultDescription
templatestringYesThe template content (max 1200 characters).
template_idstringYesUnique identifier for the template (max 100 characters).

zep_graph_create_graph

Create Graph Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description value
graph_idstringYesGraph Id
namestringNoThe name value

zep_graph_delete_context_template

Delete Context Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesTemplate ID

zep_graph_delete_custom_instructions

Delete Custom Instructions Parameters:
ParameterTypeRequiredDefaultDescription
graph_idsstring[]NoDetermines which group graphs will have their custom instructions deleted. If no graphs are provided, the project-wide custom instructions will be affected.
instruction_namesstring[]NoUnique identifier for the instructions to be deleted. If empty deletes all instructions.
user_idsstring[]NoDetermines 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:
ParameterTypeRequiredDefaultDescription
uuidstringYesEdge UUID

zep_graph_delete_episode

Delete Episode Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesEpisode UUID

zep_graph_delete_graph

Delete Graph Parameters:
ParameterTypeRequiredDefaultDescription
graphIdstringYesGraph ID

zep_graph_delete_node

Delete Node Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesNode UUID

zep_graph_detect_patterns_experimental

Detect Patterns (Experimental) Parameters:
ParameterTypeRequiredDefaultDescription
detectobjectNoThe detect value
edge_limitintegerNoMax resolved edges per pattern. Default: 10, Max: 100. Only used with query.
graph_idstringNoGraph ID when detecting patterns on a named graph
limitintegerNoMax patterns to return. Default: 50, Max: 200
min_occurrencesintegerNoMinimum occurrence count to report a pattern. Default: 2
querystringNoSearch 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_limitintegerNoMax seed nodes from search. Default: 10, Max: 50. Only used with query.
recency_weightstringNoRecency Weight
search_filtersobjectNoSearch Filters
seedsobjectNoThe seeds value
user_idstringNoUser ID when detecting patterns on a user graph

zep_graph_get_context_template

Get Context Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesTemplate ID

zep_graph_get_edge

Get Edge Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesEdge UUID

zep_graph_get_edges

Get Graph Edges Parameters:
ParameterTypeRequiredDefaultDescription
graph_idstringYesGraph ID
limitintegerNoMaximum number of items to return
uuid_cursorstringNoUUID 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:
ParameterTypeRequiredDefaultDescription
node_uuidstringYesNode UUID

zep_graph_get_episode

Get Episode Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesEpisode UUID

zep_graph_get_episodes

Get Graph Episodes Parameters:
ParameterTypeRequiredDefaultDescription
graph_idstringYesGraph ID
lastnintegerNoThe number of most recent episodes to retrieve.

zep_graph_get_episodes_for_a_node

Get Episodes for a node Parameters:
ParameterTypeRequiredDefaultDescription
node_uuidstringYesNode UUID

zep_graph_get_graph

Get Graph Parameters:
ParameterTypeRequiredDefaultDescription
graphIdstringYesThe graph_id of the graph to get.

zep_graph_get_node

Get Node Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesNode UUID

zep_graph_get_nodes

Get Graph Nodes Parameters:
ParameterTypeRequiredDefaultDescription
graph_idstringYesGraph ID
limitintegerNoMaximum number of items to return
uuid_cursorstringNoUUID 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:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID
limitintegerNoMaximum number of items to return
uuid_cursorstringNoUUID 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:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID
lastnintegerNoThe number of most recent episodes entries to retrieve.

zep_graph_get_user_nodes

Get User Nodes Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID
limitintegerNoMaximum number of items to return
uuid_cursorstringNoUUID 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:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number for pagination, starting from 1.
pageSizeintegerNoNumber of graphs to retrieve per page.
searchstringNoSearch term for filtering graphs by graph_id.
order_bystringNoColumn to sort by (created_at, group_id, name).
ascbooleanNoSort in ascending order.

zep_graph_list_context_templates

List Context Templates

zep_graph_list_custom_instructions

List Custom Instructions Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringNoUser ID to get user-specific instructions
graph_idstringNoGraph ID to get graph-specific instructions

zep_graph_list_ontology

List graph ontology

zep_graph_return_any_nodes_and_edges_mentioned_in_an_episode

Return any nodes and edges mentioned in an episode Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesEpisode uuid

zep_graph_search_graph

Search Graph Parameters:
ParameterTypeRequiredDefaultDescription
bfs_origin_node_uuidsstring[]NoNodes that are the origins of the BFS searches
center_node_uuidstringNoNode to rerank around for node distance reranking
graph_idstringNoThe graph_id to search in. When searching user graph, please use user_id instead.
limitintegerNoThe maximum number of facts to retrieve. Defaults to 10. Limited to 50.
mmr_lambdanumberNoweighting for maximal marginal relevance
querystringYesThe string to search for (required)
rerankerstringNoThe reranker value
scopestringNoThe scope value
search_filtersobjectNoSearch Filters
user_idstringNoThe user_id when searching user graph. If not searching user graph, please use graph_id instead.

zep_graph_set_ontology

Set graph ontology Parameters:
ParameterTypeRequiredDefaultDescription
edgesobjectNoDictionary mapping edge type names to their definitions with source/target constraints
entitiesobjectNoDictionary mapping entity type names to their definitions
graph_idsstring[]NoOptional list of graph IDs to apply ontology to
user_idsstring[]NoOptional list of user IDs to apply ontology to

zep_graph_update_context_template

Update Context Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesTemplate ID
templatestringYesThe template content (max 1200 characters).

zep_graph_update_edge

Update Edge Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesEdge UUID
attributesobjectNoUpdated attributes. Merged with existing attributes. Set a key to null to delete it.
expired_atstringNoUpdated time at which the edge expires
factstringNoUpdated fact for the edge
invalid_atstringNoUpdated time at which the fact stopped being true
namestringNoUpdated name (relationship type) for the edge
valid_atstringNoUpdated time at which the fact becomes true

zep_graph_update_episode_metadata

Update Episode Metadata Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesEpisode UUID
metadataobjectYesUpdated 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:
ParameterTypeRequiredDefaultDescription
graphIdstringYesGraph ID
descriptionstringNoThe description value
namestringNoThe name value

zep_graph_update_node

Update Node Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesNode UUID
attributesobjectNoUpdated attributes. Merged with existing attributes. Set a key to null to delete it.
labelsstring[]NoUpdated labels for the node
namestringNoUpdated name for the node
summarystringNoUpdated summary for the node