Skip to main content
POST
kg_walk

Authorizations

X-API-Key
string
header
required

Path Parameters

workspace_id
string<uuid>
required

Workspace identifier.

Body

application/json

Request body for kg-walk.

path_prefix filters by node provenance — a walk cannot traverse out of scope and back in, so every node in the response was sourced from a file under the prefix.

start_node_ids
string[]
required
Required array length: 1 - 50 elements
edge_types
string[] | null
hops
integer
default:2
Required range: 1 <= x <= 5
max_nodes
integer
default:100
Required range: 1 <= x <= 500
node_types
string[] | null
path_prefix
string | null

Response

Successful Response

Response body for kg-walk.

coverage
Coverage · object
required

What the access gate withheld, in counts and label names only.

Never a name, path, or fragment of withheld content. Naming the labels leaks nothing the caller cannot already read from the workspace config, and it turns "some results were withheld" into an actionable request.

edges
GraphEdge · object[]
required
nodes
GraphNode · object[]
required
paths
GraphPath · object[]
required
truncated
boolean
required