visualize

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 error field)

Notes

User must have read permissions on the dataset
Visualization is interactive and allows graph exploration

GET

api

visualize

Visualize

curl --request GET \
  --url https://{tenant}.aws.cognee.ai/api/v1/visualize \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dataset_id

string<uuid>

required

UUID of the dataset to visualize. List your datasets via GET /api/v1/datasets to find it.

Example:

""

full

boolean

default:false

Render the entire graph instead of a bounded subgraph.

query

string | null

Query string whose nearest vector hits seed the subgraph.

seed_node_ids

string[] | null

Explicit seed node ids for subgraph neighborhood expansion.

neighborhood_depth

integer

default:2

k-hop neighborhood depth for subgraph expansion.

Required range: 1 <= x <= 10

neighborhood_seed_top_k

integer

default:10

Maximum number of seed nodes.

Required range: 1 <= x <= 100

max_nodes

integer

default:500

Hard cap on rendered nodes after expansion.

Required range: 1 <= x <= 5000

Response

Successful Response

⌘I

Visualize

curl --request GET \
  --url https://{tenant}.aws.cognee.ai/api/v1/visualize \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}