curl --request POST \
--url https://ndi-api.nace.ai/v1/workspaces/{workspace_id}/tools/kg-walk \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"start_node_ids": [
"<string>"
]
}
'{
"coverage": {
"labels_required": [
"<string>"
],
"request_access_hint": "<string>",
"restricted_candidates": 0
},
"edges": [
{
"edge_id": "<string>",
"edge_type": "<string>",
"from_node_id": "<string>",
"to_node_id": "<string>",
"evidence": {
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"relevance_score": 123,
"snippet": "<string>",
"why": "<string>",
"component": "<string>",
"locator": {
"char_end": 123,
"char_start": 123,
"kind": "text_range",
"page": 123,
"pages": [
123
]
},
"page": 123
}
}
],
"nodes": [
{
"degree": 123,
"facts": [
{
"evidence": {
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"relevance_score": 123,
"snippet": "<string>",
"why": "<string>",
"component": "<string>",
"locator": {
"char_end": 123,
"char_start": 123,
"kind": "text_range",
"page": 123,
"pages": [
123
]
},
"page": 123
},
"predicate": "<string>",
"value": "<string>"
}
],
"node_id": "<string>",
"node_type": "<string>",
"source_files": [
{
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>"
}
],
"title": "<string>"
}
],
"paths": [
{
"edge_ids": [
"<string>"
],
"node_ids": [
"<string>"
]
}
],
"truncated": true
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}kg_walk
Traverse the workspace knowledge graph from a set of seed nodes.
Cost class: medium.
Performs a bounded breadth-first walk starting from start_node_ids,
returning all nodes, edges, and the paths that explain why each node was
reached. paths is not decoration: multi-hop reachability is only
trustworthy if the caller can inspect the hops that justified it.
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. Use kg_info to discover hub node IDs when you do not
have specific starting points.
curl --request POST \
--url https://ndi-api.nace.ai/v1/workspaces/{workspace_id}/tools/kg-walk \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"start_node_ids": [
"<string>"
]
}
'{
"coverage": {
"labels_required": [
"<string>"
],
"request_access_hint": "<string>",
"restricted_candidates": 0
},
"edges": [
{
"edge_id": "<string>",
"edge_type": "<string>",
"from_node_id": "<string>",
"to_node_id": "<string>",
"evidence": {
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"relevance_score": 123,
"snippet": "<string>",
"why": "<string>",
"component": "<string>",
"locator": {
"char_end": 123,
"char_start": 123,
"kind": "text_range",
"page": 123,
"pages": [
123
]
},
"page": 123
}
}
],
"nodes": [
{
"degree": 123,
"facts": [
{
"evidence": {
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"relevance_score": 123,
"snippet": "<string>",
"why": "<string>",
"component": "<string>",
"locator": {
"char_end": 123,
"char_start": 123,
"kind": "text_range",
"page": 123,
"pages": [
123
]
},
"page": 123
},
"predicate": "<string>",
"value": "<string>"
}
],
"node_id": "<string>",
"node_type": "<string>",
"source_files": [
{
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>"
}
],
"title": "<string>"
}
],
"paths": [
{
"edge_ids": [
"<string>"
],
"node_ids": [
"<string>"
]
}
],
"truncated": true
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}Authorizations
Path Parameters
Workspace identifier.
Body
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.
Response
Successful Response
Response body for kg-walk.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes