Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.swarms.ai/llms.txt

Use this file to discover all available pages before exploring further.

This comprehensive guide outlines production-grade best practices for using the Swarms API effectively. Learn how to choose the right swarm architecture, optimize costs, and implement robust error handling.

​
Quick Reference Cards

​
Swarm Types

Available Swarm Architectures
Swarm TypeBest ForUse Cases
AgentRearrangeDynamic workflows• Complex task decomposition
• Adaptive processing
• Multi-stage analysis
• Dynamic resource allocation
MixtureOfAgentsDiverse expertise• Cross-domain problems
• Comprehensive analysis
• Multi-perspective tasks
• Research synthesis
SpreadSheetSwarmData processing• Financial analysis
• Data transformation
• Batch calculations
• Report generation
SequentialWorkflowLinear processes• Document processing
• Step-by-step analysis
• Quality control
• Content pipeline
ConcurrentWorkflowParallel tasks• Batch processing
• Independent analyses
• High-throughput needs
• Multi-market analysis
GroupChatCollaborative solving• Brainstorming
• Decision making
• Problem solving
• Strategy development
MultiAgentRouterTask distribution• Load balancing
• Specialized processing
• Resource optimization
• Service routing
AutoSwarmBuilderAutomated setup• Quick prototyping
• Simple tasks
• Testing
• MVP development
HierarchicalSwarmComplex organization• Project management
• Research analysis
• Enterprise workflows
• Team automation
MajorityVotingConsensus needs• Quality assurance
• Decision validation
• Risk assessment
• Content moderation

​
Application Patterns

Specialized Application Configurations
ApplicationRecommended SwarmBenefits
Team AutomationHierarchicalSwarm• Automated team coordination
• Clear responsibility chain
• Scalable team structure
Research PipelineSequentialWorkflow• Structured research process
• Quality control at each stage
• Comprehensive output
Trading SystemConcurrentWorkflow• Multi-market coverage
• Real-time analysis
• Risk distribution
Content FactoryMixtureOfAgents• Automated content creation
• Consistent quality
• High throughput

​
Cost Optimization

Advanced Cost Management Strategies
StrategyImplementationImpact
Batch ProcessingGroup related tasks20-30% cost reduction
Off-peak UsageSchedule for 8 PM - 6 AM PT50% cost reduction (Swarm Completions only)
Token OptimizationPrecise prompts, focused tasks10-20% cost reduction
CachingStore reusable results30-40% cost reduction
Agent OptimizationUse minimum required agents15-25% cost reduction
Smart RoutingRoute to specialized agents10-15% cost reduction
Prompt EngineeringOptimize input tokens15-20% cost reduction

​
Service Tiers

Choosing the Right Service Tier
TierBest ForBenefitsConsiderations
Standard• Real-time processing
• Time-sensitive tasks
• Critical workflows		• Immediate execution
• Higher priority
• Predictable timing		• Higher cost
• 5-min timeout
Off-peak (Swarm Completions)• Batch processing
• Non-urgent tasks
• Cost-sensitive workloads		• 50% cost reduction on tokens
• 8 PM - 6 AM PT		• Only applies to Swarm Completions
• Time window restriction

​
Industry Solutions

Industry-Specific Swarm Patterns
IndustryUse CaseApplications
FinanceAutomated trading desk• Portfolio management
• Risk assessment
• Market analysis
• Trading execution
HealthcareClinical workflow automation• Patient analysis
• Diagnostic support
• Treatment planning
• Follow-up care
LegalLegal document processing• Document review
• Case analysis
• Contract review
• Compliance checks
E-commerceE-commerce operations• Product management
• Pricing optimization
• Customer support
• Inventory management

​
Error Handling

Advanced Error Management Strategies
Error CodeStrategyRecovery Pattern
400Input ValidationPre-request validation with fallback
401Auth ManagementSecure key rotation and storage
429Rate LimitingExponential backoff with queuing
500ResilienceRetry with circuit breaking
503High AvailabilityMulti-region redundancy
504Timeout HandlingAdaptive timeouts with partial results

​
Choosing the Right Swarm Architecture

​
Decision Framework

Use this framework to select the optimal swarm architecture for your use case:
  1. Task Complexity Analysis
    • Simple tasks → AutoSwarmBuilder
    • Complex tasks → HierarchicalSwarm or MultiAgentRouter
    • Dynamic tasks → AgentRearrange
  2. Workflow Pattern
    • Linear processes → SequentialWorkflow
    • Parallel operations → ConcurrentWorkflow
    • Collaborative tasks → GroupChat
  3. Domain Requirements
    • Multi-domain expertise → MixtureOfAgents
    • Data processing → SpreadSheetSwarm
    • Quality assurance → MajorityVoting

​
Industry-Specific Recommendations

​
Finance

Financial Applications
  • Risk Analysis: HierarchicalSwarm
  • Market Research: MixtureOfAgents
  • Trading Strategies: ConcurrentWorkflow
  • Portfolio Management: SpreadSheetSwarm

​
Healthcare

Healthcare Applications
  • Patient Analysis: SequentialWorkflow
  • Research Review: MajorityVoting
  • Treatment Planning: GroupChat
  • Medical Records: MultiAgentRouter
Legal Applications
  • Document Review: SequentialWorkflow
  • Case Analysis: MixtureOfAgents
  • Compliance Check: HierarchicalSwarm
  • Contract Analysis: ConcurrentWorkflow

​
Production Best Practices

​
Best Practices Summary

Recommended Patterns
  • Use appropriate swarm types for tasks
  • Implement robust error handling
  • Monitor and log executions
  • Cache repeated results
  • Rotate API keys regularly
  • Choose appropriate service tier based on task urgency
  • Schedule non-urgent tasks during off-peak hours (8 PM - 6 AM PT) for Swarm Completions to benefit from night-time discount
Anti-patterns to Avoid
  • Hardcoding API keys
  • Ignoring rate limits
  • Missing error handling
  • Excessive agent count
  • Inadequate monitoring
  • Not implementing retry logic for failed requests

​
Performance Benchmarks

Typical Performance Metrics
MetricTarget RangeWarning Threshold
Response Time< 2s> 5s
Success Rate> 99%< 95%
Cost per Task< $0.05> $0.10
Cache Hit Rate> 80%< 60%
Error Rate< 1%> 5%
Retry Rate< 10%> 30%

​
Additional Resources

Useful Links