visualize

Visualize

Generate an HTML visualization of the dataset’s knowledge graph.

This endpoint creates an interactive HTML visualization of the knowledge graph for a specific dataset. The visualization displays nodes and edges representing entities and their relationships, allowing users to explore the graph structure visually.

Query Parameters

dataset_id (UUID): The unique identifier of the dataset to visualize

Response

Returns an HTML page containing the interactive graph visualization.

Error Codes

404 Not Found: Dataset doesn’t exist
403 Forbidden: User doesn’t have permission to read the dataset
500 Internal Server Error: Error generating visualization

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://api.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

Response

Successful Response

Visualize MultiGenerate a combined HTML visualization of graph data from multiple users' datasets. This endpoint aggregates knowledge graphs from multiple user+dataset pairs into a single interactive visualization, with each user's nodes tagged for color-by-user rendering. ## Request Body A JSON array of objects, each with: - **user_id** (UUID): The user who owns the dataset - **dataset_id** (UUID): The dataset to include ## Response Returns an HTML page containing the combined interactive graph visualization. ## Notes - Requires superuser privileges to view other users' data - Each user+dataset pair must exist and be accessible

⌘I

Visualize

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

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

Documentation Index

Authorizations

Query Parameters

Response