Visualize Json

Return the dataset’s knowledge graph as a JSON-safe payload.

Same authorization, dataset resolution and bounded fetch as GET /visualize — pass the same arguments to get the JSON behind the same subgraph the HTML page would have shown. Does not include the semantic layout; see GET /visualize/semantic for that, computed separately so a client that never opens the semantic tab never pays for it.

Query Parameters

Same as GET /visualize (dataset_id, full, query, seed_node_ids, neighborhood_depth, neighborhood_seed_top_k, max_nodes), plus stream.

Response

A JSON object with nodes, links, color_maps, schema_graph, schema_data, pipeline_stages, edge_classes, bundles, provenance_index, has_meaningful_topological_rank, memory_map and search_events.

Streaming

Sent when the request has Accept: text/event-stream or stream=true, for graphs too large for one response. Events: meta (seeds, seed source, bounds); one chunk per read, with compact nodes (id, name, type, stage, is_unnamed, belongs_to_set, source_node_set) and links (source, target, relation, edge_class) whose endpoints were all sent in this or an earlier chunk; summary (importance and label_priority per node, split into events of at most one chunk’s size, the first also carrying color_maps.node_set); done (totals). A failure after the response started is one error event with message and status. The heavy side payloads are not streamed, and full=true cannot be streamed.

Error Codes

• 409 Conflict: Dataset not found, permission denied, or the payload could not be built (generic message; full detail is server-logged, not returned, to avoid leaking internals)
• Request validation error (400 on the cognee server, like any invalid parameter): max_nodes above 5000 without streaming, or full=true with streaming
• 503 Service Unavailable: streamed, and this server already has its maximum number of graph streams open; retry shortly

Notes

• User must have read permissions on the dataset

GET /api/v1/visualize/json

Visualize Json

cURL

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

422

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

Authorizations

BearerAuthApiKeyAuth

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

Include 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. Up to 5000 as JSON, up to 20000 when streamed.

Required range: 1 <= x <= 20000

stream · boolean | null

Stream the graph as server-sent events. Defaults to content negotiation on Accept; true or false decides outright.

Response

200

application/json

Successful Response