Walk the graph outward from an entity in a space

GET

/spaces/:spaceId/ontology/entities/:entityId/related

GET

/spaces/:spaceId/ontology/entities/:entityId/related

$ curl https://api.cloudraker.com/spaces/spaceId/ontology/entities/entityId/related \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entities": [
3     {
4       "id": "ent-9f8b7c6d",
5       "type": "organization",
6       "name": "Acme Corporation",
7       "distance": 1
8     },
9     {
10       "id": "ent-4a3d2e1f",
11       "type": "person",
12       "name": "Jane Doe",
13       "distance": 1
14     },
15     {
16       "id": "ent-7c5e3b2a",
17       "type": "project",
18       "name": "Project Phoenix",
19       "distance": 2
20     }
21   ],
22   "edges": [
23     {
24       "sourceId": "ent-4a3d2e1f",
25       "targetId": "ent-9f8b7c6d",
26       "relation": "employed_by",
27       "fileId": "file-20240401-xyz"
28     },
29     {
30       "sourceId": "ent-4a3d2e1f",
31       "targetId": "ent-7c5e3b2a",
32       "relation": "works_on",
33       "fileId": "file-20240328-abc"
34     }
35   ]
36 }

Returns the neighbourhood of an entity: { entities, edges } reachable within ?depth= hops (1-3, default 1). Each neighbour entity carries id, type, name, and distance (hop count from the seed); edges carry sourceId, targetId, relation, fileId. Use it to expand context around a match. Requires space:read on :spaceId; missing access surfaces as a 404.

Returns the neighbourhood of an entity: `{ entities, edges }` reachable within `?depth=` hops (1-3, default 1). Each neighbour entity carries `id`, `type`, `name`, and `distance` (hop count from the seed); edges carry `sourceId`, `targetId`, `relation`, `fileId`. Use it to expand context around a match. Requires `space:read` on `:spaceId`; missing access surfaces as a 404.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

entityIdstringRequired

Query parameters

depthintegerOptional1-3Defaults to 1

Hops to walk, 1–3. Defaults to 1.

Response

Neighbouring entities and the connecting edges.

entitieslist of objects

edgeslist of objects