Skip to navigation

Walk the graph outward from an entity in a space

View as Markdown

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.

Response

Neighbouring entities and the connecting edges.
entitieslist of objects
edgeslist of objects