Skip to navigation

Update edge

Updates one edge. When the edge belongs to a hyperedge, changing fact rewrites it on every member of that hyperedge in one all-or-nothing write, because the members share it. Attribute-only edits touch this edge alone.

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Path parameters

graph_uuidstringRequired
Graph UUID
edge_uuidstringRequired
Edge UUID

Request

Request body
attributesobject or nullOptional

Additional attributes to merge onto the edge; a key set to null is removed.

factstringOptional
The fact text describing the relationship between the source and target nodes.

Response

OK
attributesmap from strings to anyOptional
Additional attributes of the edge.
created_atstringOptional
The time the edge was created.
episode_uuidslist of stringsOptional
The episodes this edge was derived from.
expired_atstringOptional
The time the fact was superseded or removed.
factstringOptional

The natural-language fact this edge represents.

graph_uuidstringOptional
The unique identifier of the graph this edge belongs to.
hyperedge_uuidstringOptional
The unique identifier of the hyperedge this edge is a member of. Omitted when the edge is not part of a hyperedge.
invalid_atstringOptional
The time at which the fact stopped being true.
namestringOptional

The name of the edge, in upper snake case, for example RELATES_TO.

relevancedoubleOptional

A cross-encoder-derived relevance score, present only when the cross-encoder reranker scored this result; like score, it is omitted from plain list results.

scopestringOptional
The kind of edge this is, for example entity or episodic.
scoredoubleOptional

The ranking score returned with every search result; omitted when the edge appears in a plain list rather than a search result.

source_node_labelslist of stringsOptional
The current labels of the source node. This is read at request time rather than stored on the edge, and is omitted when the source node cannot be resolved.
source_node_namestringOptional
The current name of the source node. This is read at request time rather than stored on the edge, and is omitted when the source node cannot be resolved.
source_node_uuidstringOptional
The unique identifier of the edge's source node.
target_node_labelslist of stringsOptional
The current labels of the target node. This is read at request time rather than stored on the edge, and is omitted when the target node cannot be resolved.
target_node_namestringOptional
The current name of the target node. This is read at request time rather than stored on the edge, and is omitted when the target node cannot be resolved.
target_node_uuidstringOptional
The unique identifier of the edge's target node.
uuidstringOptional
The unique identifier of the edge.
valid_atstringOptional
The time from which the fact is considered true.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error