Visualize
Generate an HTML visualization of the dataset’s knowledge graph.
By default renders a bounded subgraph around relevant seed nodes; pass
full=true to render the entire graph (legacy behavior). Seeds come
from query or seed_node_ids when given, otherwise the graph’s
highest-degree nodes.
Query Parameters
- dataset_id (UUID): The unique identifier of the dataset to visualize
- full (bool): Render the full graph when true
- query (str): Query string to seed the subgraph via vector search
- seed_node_ids (list[str]): Explicit seed node ids
- neighborhood_depth (int): k-hop expansion depth (default 2)
- neighborhood_seed_top_k (int): Max seeds (default 10)
- max_nodes (int): Node cap after expansion (default 500)
Response
Returns an HTML page containing the interactive graph visualization.
Error Codes
- 409 Conflict: Dataset not found, permission denied, or visualization
failed (detail in the
errorfield)
Notes
- User must have read permissions on the dataset
- Visualization is interactive and allows graph exploration
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
UUID of the dataset to visualize. List your datasets via GET /api/v1/datasets to find it.
""
Render the entire graph instead of a bounded subgraph.
Query string whose nearest vector hits seed the subgraph.
Explicit seed node ids for subgraph neighborhood expansion.
k-hop neighborhood depth for subgraph expansion.
1 <= x <= 10Maximum number of seed nodes.
1 <= x <= 100Hard cap on rendered nodes after expansion.
1 <= x <= 5000Response
Successful Response