Get Entity Relationships
Get relationships for a specific entity.
Returns all connected entities and memories via RELATES_TO and MENTIONS relationships.
Path Parameters
entity_idstring
Query Parameters
depth?integer
Traversal depth for relationships
Default
1Range
1 <= value <= 3limit?integer
Maximum relationships to return
Default
50Range
1 <= value <= 200Response Body
application/json
application/json
curl -X GET "http://127.0.0.1:14242/entities/string/relationships?depth=1&limit=50"{
"entity": {
"id": "string",
"name": "string",
"type": "string",
"description": ""
},
"relationships": {
"relates_to": [
{
"source_entity": {
"id": "string",
"name": "string",
"type": "string",
"description": ""
},
"target_entity": {
"id": "string",
"name": "string",
"type": "string",
"description": ""
},
"relationship": {
"type": "string",
"confidence": 0,
"strength": 0
},
"depth": 0
}
],
"mentioned_in": [
{
"memory": {
"id": "string",
"title": "",
"content": ""
},
"confidence": 0,
"mention_count": 0
}
]
},
"metadata": {
"total_relates_to": 0,
"total_mentions": 0,
"traversal_depth": 0,
"limit": 0
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}