Overview
The List Chunking Nodes endpoint allows you to retrieve information about chunking nodes within a flow. Chunking nodes process document content by dividing it into smaller, manageable pieces and generating vector embeddings for similarity search and retrieval operations.- Method:
GET
- URL:
https://{flow_name}.flows.graphorlm.com/chunking
- 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 chunking node objects:Response Structure
Each chunking node in the array contains:Field | Type | Description |
---|---|---|
id | string | Unique identifier for the chunking node |
type | string | Node type (always “chunking” for chunking nodes) |
position | object | Position coordinates in the flow canvas |
style | object | Visual styling properties (height, width) |
data | object | Chunking 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 chunking node |
config | object | Node configuration including chunking settings |
result | object | Processing results and status information (optional) |
Config Object
Field | Type | Description |
---|---|---|
embeddingModel | string | Embedding model used for generating vectors (e.g., “text-embedding-3-small”, “colqwen”) |
chunkingSplitter | string | Type of splitter: “character”, “token”, “semantic”, “title”, or “element” |
chunkSize | integer | Size of each chunk in characters or tokens |
chunkOverlap | integer | Number of characters/tokens that overlap between consecutive chunks |
chunkSeparator | string | Text separator used for splitting (default: “\n\n”) |
splitLevel | integer | Split level for hierarchical splitters (default: 0) |
elementsToRemove | array | List of document elements to remove during 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 |
total_chunks | integer | Number of chunks generated (if available) |
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 chunking nodes"} |
Error Response Format
Example Error Responses
Invalid API Token
Flow Not Found
Server Error
Use Cases
Chunking Node Management
Use this endpoint to:- Configuration Review: Examine chunking settings like embedding models and splitter types
- Performance Monitoring: Check processing status and chunk generation metrics
- Flow Optimization: Analyze chunking configurations for optimal performance
- Debugging: Identify issues with chunking node configurations or processing
Integration Examples
Chunking Performance Monitor
Configuration Validator
Best Practices
Configuration Management
- Optimal Chunk Size: Choose chunk sizes between 500-2000 characters for most use cases
- Appropriate Overlap: Use 10-20% overlap to maintain context between chunks
- Embedding Model Selection: Choose embedding models based on your language and domain requirements
- Splitter Selection: Use “semantic” splitters for better content preservation when possible
Performance Optimization
- Monitor Processing: Regularly check node status to ensure chunking is completing successfully
- Batch Processing: For large documents, consider the processing time implications
- Resource Management: Balance chunk size and overlap with processing performance
- Error Handling: Implement proper error handling for chunking failures
Monitoring and Maintenance
- Regular Health Checks: Monitor chunking nodes to ensure they’re processing correctly
- Configuration Validation: Verify that chunking settings are appropriate for your content
- Performance Tracking: Monitor chunk generation metrics and processing times
- Update Coordination: Coordinate chunking updates with downstream processing nodes
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 Chunking Nodes Array
Empty Chunking Nodes Array
Solution: If no chunking nodes are returned:
- Verify the flow contains chunking components
- Check that chunking nodes have been added to the flow
- Ensure the flow has been saved after adding chunking nodes
- Confirm you’re checking the correct flow
Invalid Configuration Settings
Invalid Configuration Settings
Solution: If chunking nodes have invalid configurations:
- Verify chunk size is appropriate for the selected splitter type
- Ensure chunk overlap is less than chunk size
- Check that the embedding model is supported
- Validate splitter type is one of: character, token, semantic, title, element
Processing Status Issues
Processing Status Issues
Solution: If nodes show persistent processing or error status:
- Check if chunking is taking longer due to large document size
- Verify that upstream dataset nodes are configured correctly
- Monitor system resources and processing capacity
- Review error logs for specific processing issues
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
Next Steps
After retrieving chunking node information, you might want to:Update Chunking Configuration
Modify chunking node settings like chunk size, overlap, and embedding model
List Dataset Nodes
View dataset nodes that provide input to chunking nodes
Run Flow
Execute your flow with the configured chunking nodes
Flow Overview
Learn about all available flow management endpoints