Overview
The List Graph RAG Nodes endpoint allows you to retrieve information about graph RAG nodes within a flow. Graph RAG nodes process document content by extracting entities and relationships, building knowledge graphs, and providing contextually enriched retrieval results with semantic understanding.- Method:
GET
- URL:
https://{flow_name}.flows.graphorlm.com/graph-rag
- Authentication: Required (API Token)
Authentication
All requests must include a valid API token in the Authorization header:Learn how to generate API tokens in the API Tokens guide.
Request Format
Headers
Header | Value | Required |
---|---|---|
Authorization | Bearer YOUR_API_TOKEN | Yes |
Parameters
No query parameters are required for this endpoint.Example Request
Response Format
Success Response (200 OK)
The response contains an array of graph RAG node objects:Response Structure
Each graph RAG node in the array contains:Field | Type | Description |
---|---|---|
id | string | Unique identifier for the graph RAG node |
type | string | Node type (always “graph-rag” for graph RAG nodes) |
position | object | Position coordinates in the flow canvas |
style | object | Visual styling properties (height, width) |
data | object | Graph RAG node configuration and results |
Position Object
Field | Type | Description |
---|---|---|
x | number | X coordinate position in the flow canvas |
y | number | Y coordinate position in the flow canvas |
Style Object
Field | Type | Description |
---|---|---|
height | integer | Height of the node in pixels |
width | integer | Width of the node in pixels |
Data Object
Field | Type | Description |
---|---|---|
name | string | Display name of the graph RAG node |
config | object | Node configuration including graph RAG settings |
result | object | Processing results and status information (optional) |
Config Object
Field | Type | Description |
---|---|---|
topK | integer | null | Number of top results to retrieve after graph processing. Set to null for unlimited processing |
Result Object (Optional)
Field | Type | Description |
---|---|---|
updated | boolean | Whether the node has been processed with current configuration |
processing | boolean | Whether the node is currently being processed |
waiting | boolean | Whether the node is waiting for dependencies |
has_error | boolean | Whether the node encountered an error during processing |
updatedMetrics | boolean | Whether evaluation metrics have been computed |
total_processed | integer | Total number of documents processed through the graph RAG pipeline |
total_chunks | integer | Number of chunks generated during document processing |
total_retrieved | integer | Number of documents retrieved in recent queries |
total_entities | integer | Number of entities extracted from the knowledge graph |
total_relationships | integer | Number of relationships identified between entities |
Code Examples
JavaScript/Node.js
Python
cURL
PHP
Error Responses
Common Error Codes
Status Code | Description | Example Response |
---|---|---|
401 | Unauthorized - Invalid or missing API token | {"detail": "Invalid authentication credentials"} |
404 | Not Found - Flow not found | {"detail": "Flow not found"} |
500 | Internal Server Error - Server error | {"detail": "Failed to retrieve graph RAG nodes"} |
Error Response Format
Example Error Responses
Invalid API Token
Flow Not Found
Server Error
Use Cases
Graph RAG Node Management
Use this endpoint to:- Knowledge Graph Monitoring: Track entity extraction and relationship building progress
- Performance Analysis: Monitor graph RAG processing efficiency and resource usage
- Quality Assessment: Evaluate knowledge graph coverage and connectivity metrics
- Configuration Review: Analyze Top K settings and their impact on retrieval quality
- Debugging: Identify issues with graph construction or entity extraction processes
Integration Examples
Graph RAG Performance Monitor
Knowledge Graph Quality Validator
Best Practices
Knowledge Graph Management
- Entity Quality: Monitor entity extraction quality and density metrics regularly
- Relationship Mapping: Ensure relationships between entities are meaningful and accurate
- Graph Connectivity: Maintain optimal connectivity ratios for effective knowledge retrieval
- Configuration Tuning: Adjust Top K values based on knowledge coverage requirements
Performance Optimization
- Resource Monitoring: Track processing resource usage across different configurations
- Batch Processing: Optimize entity extraction batch sizes for performance
- Incremental Updates: Implement incremental graph updates to reduce processing overhead
- Quality vs Speed: Balance graph extraction quality with processing speed requirements
Quality Assurance
- Entity Validation: Regularly validate extracted entities for accuracy and relevance
- Relationship Quality: Monitor relationship extraction quality and semantic accuracy
- Knowledge Coverage: Ensure comprehensive knowledge extraction from source documents
- Retrieval Effectiveness: Track how well the knowledge graph improves retrieval results
Troubleshooting
Flow Not Found Error
Flow Not Found Error
Solution: Verify that:
- The flow name in the URL is correct and matches exactly
- The flow exists in your project
- Your API token has access to the correct project
- The flow has been created and saved properly
Empty Graph RAG Nodes Array
Empty Graph RAG Nodes Array
Solution: If no graph RAG nodes are returned:
- Verify the flow contains graph RAG components
- Check that graph RAG nodes have been added to the flow
- Ensure the flow has been saved after adding graph RAG nodes
- Confirm you’re checking the correct flow
Low Entity Extraction Quality
Low Entity Extraction Quality
Solution: If graph RAG nodes show poor entity density:
- Review source document quality and structure
- Check if documents contain sufficient entity-rich content
- Consider adjusting NLP extraction parameters
- Validate that entity types align with your domain
Poor Graph Connectivity
Poor Graph Connectivity
Solution: If relationship ratios are low:
- Review relationship extraction configuration
- Ensure documents contain relational content
- Check if entity types support meaningful relationships
- Consider expanding allowed relationship types
Processing Performance Issues
Processing Performance Issues
Solution: If graph RAG processing is slow:
- Monitor resource usage during entity extraction
- Consider reducing batch sizes for NLP processing
- Review Top K configurations for optimization
- Check for bottlenecks in graph storage operations
Connection Issues
Connection Issues
Solution: For connectivity problems:
- Check your internet connection
- Verify the flow URL is accessible
- Ensure your firewall allows HTTPS traffic to *.flows.graphorlm.com
- Try accessing the endpoint from a different network