Get Knowledge Graph
curl --request GET \
--url https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/ \
--header 'x-api-key: <api-key>'import requests
url = "https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"nodes": [
{
"id": "<string>",
"label": "<string>",
"properties": {}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"type": "<string>",
"properties": {}
}
],
"metadata": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Graph Visualization Error: '1223242' is not a valid ObjectId, it must be a 12-byte input or a 24-character hex string"
}API Reference
Get Knowledge Graph
Get the knowledge graph visualization data for a Neo4j-based RAG system (nodes, edges, and metadata).
GET
/
v4
/
knowledge_graph
/
neo4j
/
graph
/
Get Knowledge Graph
curl --request GET \
--url https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/ \
--header 'x-api-key: <api-key>'import requests
url = "https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rag-prod.studio.lyzr.ai/v4/knowledge_graph/neo4j/graph/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"nodes": [
{
"id": "<string>",
"label": "<string>",
"properties": {}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"type": "<string>",
"properties": {}
}
],
"metadata": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Graph Visualization Error: '1223242' is not a valid ObjectId, it must be a 12-byte input or a 24-character hex string"
}Authorizations
Query Parameters
The unique identifier (ID) of the RAG system to retrieve the graph for.
Example:
"654c602a46c3b6d4e28741b0"
Maximum number of nodes to return to control the visualization size.
Required range:
x >= 1⌘I