Documentation
Whether you're building AI agents or providing APIs, find everything you need to succeed with Solariz.
Documentation
Need help?
Contact SupportAPI Clusters
API Clusters allow you to group related APIs together, creating powerful combinations that can work seamlessly to handle complex requests. This enables Solariz to route queries to the right services automatically.
What Are API Clusters?
An API Cluster is a logical grouping of APIs that work together to fulfill certain types of requests. For example, a "Travel Planning" cluster might include:
Example: Travel Planning Cluster
When a user asks a question like 'Help me organize a 1-week trip from London to Paris for 2 adults in July, including flights, attractions, and hotels?', the AI can use multiple APIs in the cluster to provide a comprehensive response.
💡 Why Use Clusters?
Clusters simplify complex operations by letting the AI decide which API to use based on the context of the query. You don't need to specifically direct requests to individual APIs.
Creating API Clusters
Follow these steps to create an API cluster:
Required Fields
A descriptive name (e.g., 'Travel Planning Cluster')
Choose between Private (only visible to you) or Public (visible to all users)
Choose which APIs to include in this cluster
⚠️ Important Note
Make sure the APIs you select for a cluster are functionally related. Grouping unrelated APIs may lead to confusion for your AI agents and inefficient routing of queries.
Managing Your Clusters
Once created, you can view, edit, and manage your clusters:
Viewing Cluster Details
See cluster information, APIs, and management options
Editing a Cluster
Modify cluster properties and API membership
Deleting a Cluster
Permanently remove a cluster (APIs remain intact)
🚨 Deletion Warning
Deleting a cluster is permanent and cannot be undone. This action will not delete the individual APIs, but any AI agents or workflows that reference the cluster will need to be updated.
Cluster Types Explained
Choose the right cluster type based on your access and sharing requirements:
Private Clusters
Only accessible within your organization
Ideal for:
Public Clusters
Shared with all users in the system
Ideal for:
Best Practices for API Clusters
Follow these best practices to create effective and maintainable clusters:
Logical Grouping
Group APIs that naturally work together to solve specific problems
Clear Naming
Use descriptive names that indicate the purpose or domain of the cluster
Right-Sizing
Include enough APIs to be useful, but not so many that the cluster becomes confusing
Regular Testing
Test your clusters regularly with various queries to ensure they perform as expected
Monitor Usage
Track which APIs are used most frequently to identify optimization opportunities