Graphify Knowledge Graph Guide
Learn how to visualize your project's documents, source, and tags as a 3D knowledge graph and explore the connections between nodes.
📋 Overview
Graphify renders the documents, source code, and tags of the selected project (csn) as a 3D knowledge graph of nodes and links. Nodes are colored by type and ranked by importance (weighted link count) when displayed.
🔍 Key Element Descriptions
1. Top Header
Shows the number of currently rendered nodes, the total node count, and the number of links in the format shown / total nodes · N links.
2. Node Search
Type part of a label or path into the header search box to find matching nodes across the entire node set; results appear as a list on the left. Clicking a result brings that node into the graph and selects it.
3. 3D Graph Canvas
Nodes are color-coded by type, as shown in the bottom-left legend: Doc / Spec (amber), Code / Source (sky blue), and Tag (green). Clicking a node selects it and opens the inspector; clicking the background clears the selection.
4. Node Inspector (Right Panel)
Displays the selected node's type badge, link count, and path, along with two relation lists:
- Backlinks: nodes that point to (link into) this node
- Outgoing links: nodes that this node points to
Clicking an item navigates (drills down) to that node; use the back button at the top-left of the panel to return to the previous node.
5. Document Body Popup
Clicking the node title in the inspector opens a layer popup. If the node is a KB document (path kb/<number>), its full body is rendered as Markdown. Other nodes show a notice that there is no body to display. Press Esc to close the popup.
🛠️ Tips
- Load more: For performance, the graph first shows only the top 50 nodes by importance. Use the [Load N more] button at the bottom center to reveal the next 50.
- Sync: Click the [Sync] button at the top right of the header to reload the graph data.
💡 Important Notes
- If no project is selected, the "No Project Selected" screen appears. Select a project from the top navigation.
- Viewing the graph works without logging in, but the body of a KB document requires login (an authentication token) to open.
🔌 Managing the Graph via API (Add · Edit · Delete · Rebuild)
The Graphify graph is derived from KB entries (tKB). Add, edit, or delete entries via API, then call rebuild to reflect them in the graph. Connections (edges) are not drawn by hand — rebuild generates them automatically from your entries.
- Host:
https://giipfaw.azurewebsites.net - Auth: Every write API requires the logged-in user's AK or a project-scoped SK in the
x-api-keyheader. A key may add/edit/delete/rebuild only within its owncsnscope. - Workflow:
add/edit/delete (giipKb)→rebuild (giipGraphifyRebuild)→verify (giipGraphify)
1) Add a node — giipKb POST
curl -X POST "https://giipfaw.azurewebsites.net/api/giipKb" \
-H "x-api-key: <AK_OR_SK>" -H "Content-Type: application/json" \
-d '{"csn":47,"title":"OAuth callback 500","content":"## Cause\ntoken exchange timeout","tags":"auth,oauth,timeout","refType":"ISSUE","extRefId":"ISSUE-1001"}'
titlebecomes the node label;contentis rendered as the body popup (Markdown) when the node is clicked.- Providing
extRefIdmakes it an idempotent upsert — resending with the same value updates instead of creating a duplicate. - Response:
{ "success": true, "kbSn": 844, "message": "..." }
2) Edit a node — giipKb PUT
curl -X PUT "https://giipfaw.azurewebsites.net/api/giipKb" \
-H "x-api-key: <AK_OR_SK>" -H "Content-Type: application/json" \
-d '{"kbSn":844,"title":"OAuth callback 500 (resolved)","content":"## Fix\ntimeout 30s->90s","tags":"auth,oauth,resolved"}'
- Identify the target entry with
kbSn.
3) Delete a node — giipKb DELETE
curl -X DELETE "https://giipfaw.azurewebsites.net/api/giipKb?kbSn=844" \
-H "x-api-key: <AK_OR_SK>"
4) Rebuild (generate connections) — giipGraphifyRebuild POST
You must call this after adding/editing/deleting entries for changes to appear. It regenerates the nodes and edges for that csn from the KB entries.
curl -X POST "https://giipfaw.azurewebsites.net/api/giipGraphifyRebuild" \
-H "x-api-key: <AK_OR_SK>" -H "Content-Type: application/json" \
-d '{"csn":47}'
- Response:
{ "success": true, "csn": 47, "nodes": 838, "edges": 11, "message": "Graph rebuilt" } - Optional params (performance tuning for large projects):
maxNodes: cap on the most recent entries to graph (default 400)scanLen: length of the body prefix scanned when finding connections (default 1500)
-d '{"csn":47,"maxNodes":800,"scanLen":2000}'
5) Read the graph — giipGraphify GET
The read API the page uses internally (works without auth). To check directly:
curl "https://giipfaw.azurewebsites.net/api/giipGraphify?csn=47"
- Response:
{ "nodes": [...], "links": [...] }
For the full field reference, see 📘 API Reference Overview.
Troubleshooting
| Symptom | Cause | Resolution |
|---|---|---|
| Only "No Project Selected" is shown | No project (csn) is specified | Select a project from the top navigation. |
| Document popup shows "login required" | No auth token for fetching the KB body | Log in and click the node title again. |
| A node shows no body | The node is not a KB document (kb/…) | Bodies are provided only for KB document nodes. This is expected behavior. |
| Some nodes are not visible in the graph | Only the top 50 by importance are shown first | Use [Load N more] at the bottom, or search to bring a node into view. |
API Error or load failure | Session expired or server response error | Click [Retry] on the error banner, or log in again. |
Version: 1.0
Last Updated: 2026-07-22
Source: giipv3/public/help/graphify.en.md