Update Edge | Zep Documentation

Updates an entity edge by UUID.

Path parameters

uuidstringRequired

Edge UUID

Request

Update edge request

attributesmap from strings to anyOptional

Updated attributes. Merged with existing attributes. Set a key to null to delete it.

expired_atstringOptional

Updated time at which the edge expires

factstringOptional<=250 characters

Updated fact for the edge

invalid_atstringOptional

Updated time at which the fact stopped being true

namestringOptional1-50 characters

Updated name (relationship type) for the edge

valid_atstringOptional

Updated time at which the fact becomes true

Response

Updated edge

created_atstring

Creation time of the edge

factstring

Fact representing the edge and nodes that it connects

namestring

Name of the edge, relation name

source_node_uuidstring

UUID of the source node

target_node_uuidstring

UUID of the target node

uuidstring

UUID of the edge

attributesmap from strings to anyOptional

Additional attributes of the edge. Dependent on edge types

episodeslist of stringsOptional

List of episode ids that reference these entity edges

expired_atstringOptional

Datetime of when the node was invalidated

hyperedge_uuidstringOptional

HyperedgeUUID groups the pairwise edges projected from the same atomic multi-entity fact. Omitted when the edge is not part of a hyperedge.

invalid_atstringOptional

Datetime of when the fact stopped being true

relevancedoubleOptional

Relevance is an experimental rank-aligned score in [0,1] derived from Score via logit transformation. Only populated when using cross_encoder reranker; omitted for other reranker types (e.g., RRF).

scopestringOptional

Scope of the edge (e.g. "entity", "maybe_related")

scoredoubleOptional

Score is the reranker output: sigmoid-distributed logits [0,1] when using cross_encoder reranker, or RRF ordinal rank when using rrf reranker

selection_rankintegerOptional

SelectionRank is the global cross-scope rank assigned by auto scope selection.

source_node_labelslist of stringsOptional

SourceNodeLabels are the labels of the source node at read time. Same read-time-projection semantics as SourceNodeName.

source_node_namestringOptional

SourceNodeName is the name of the source node at read time. It is a read-time projection of current node state, not a stored edge attribute: a subsequent node rename is reflected on the next read. Omitted (the edge is still returned) if the source node cannot be resolved, for example if it was deleted concurrently.

target_node_labelslist of stringsOptional

TargetNodeLabels are the labels of the target node at read time. Same read-time-projection semantics as SourceNodeName.

target_node_namestringOptional

TargetNodeName is the name of the target node at read time. Same read-time-projection semantics as SourceNodeName.

valid_atstringOptional

Datetime of when the fact became true

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error