# swarms

## Docs

- [Agent Configuration](https://docs.swarms.world/agents/agent-configuration.md): Complete guide to configuring agents with all available parameters
- [Agent Memory](https://docs.swarms.world/agents/agent-memory.md): Understanding and configuring agent memory and conversation history
- [Agent Skills](https://docs.swarms.world/agents/agent-skills.md): Learn about the markdown-based Agent Skills system for modular agent capabilities
- [Agent Tools](https://docs.swarms.world/agents/agent-tools.md): Add tools and function calling capabilities to agents
- [Creating Agents](https://docs.swarms.world/agents/creating-agents.md): Learn how to create and initialize agents in the Swarms framework
- [Structured Outputs](https://docs.swarms.world/agents/structured-outputs.md): Get structured, typed responses from agents using JSON schemas and Pydantic models
- [Agent](https://docs.swarms.world/api/agent.md): The core Agent class for building autonomous AI agents with tools, memory, and multi-modal capabilities
- [AgentRearrange](https://docs.swarms.world/api/agent-rearrange.md): A sophisticated multi-agent system for dynamic task orchestration with custom flow patterns
- [AOP (Agent Orchestration Platform)](https://docs.swarms.world/api/aop.md): Deploy multiple Swarms agents as tools in an MCP (Model Context Protocol) server with queue-based execution and persistence
- [AutoSwarmBuilder](https://docs.swarms.world/api/auto-swarm-builder.md): Automatically builds and manages swarms of AI agents with intelligent task decomposition
- [BaseStructure](https://docs.swarms.world/api/base-structure.md): Foundation class providing core functionality for swarm structures and agent systems
- [BaseSwarm](https://docs.swarms.world/api/base-swarm.md): Abstract base class for building multi-agent swarm architectures
- [ConcurrentWorkflow](https://docs.swarms.world/api/concurrent-workflow.md): A concurrent workflow system for running multiple agents simultaneously on the same task
- [Conversation](https://docs.swarms.world/api/conversation.md): A class to manage conversation history with in-memory storage, supporting multiple export formats and automatic token management
- [CouncilAsAJudge](https://docs.swarms.world/api/council-as-judge.md): A council of AI agents that evaluates task responses across multiple dimensions in parallel, then aggregates findings into a comprehensive report
- [CronJob](https://docs.swarms.world/api/cron-job.md): Schedule and run Swarms agents at specified intervals with cron-style scheduling
- [GraphWorkflow](https://docs.swarms.world/api/graph-workflow.md): A powerful DAG-based workflow system for complex multi-agent orchestration with parallel execution
- [GroupChat](https://docs.swarms.world/api/group-chat.md): Collaborative conversations among multiple agents with flexible speaker selection strategies
- [HeavySwarm](https://docs.swarms.world/api/heavy-swarm.md): A sophisticated multi-agent system that decomposes tasks into specialized questions and executes them with synthesis
- [HierarchicalSwarm](https://docs.swarms.world/api/hierarchical-swarm.md): A hierarchical multi-agent orchestrator that coordinates agents through a director
- [LLMCouncil](https://docs.swarms.world/api/llm-council.md): A collaborative council of LLM agents that independently answer queries, review each other's responses, and synthesize the best elements into a final answer
- [MixtureOfAgents](https://docs.swarms.world/api/mixture-of-agents.md): A multi-agent system that runs agents in parallel layers and aggregates their responses
- [MultiAgentRouter](https://docs.swarms.world/api/multi-agent-router.md): Routes tasks to specialized agents based on their capabilities using an intelligent boss agent
- [Prompts](https://docs.swarms.world/api/prompts.md): Complete reference for the Swarms prompts module including the Prompt class and pre-built prompt templates
- [RoundRobinSwarm](https://docs.swarms.world/api/round-robin-swarm.md): A swarm that executes tasks in a randomized round-robin fashion with AutoGen-style agent communication
- [Schemas](https://docs.swarms.world/api/schemas.md): Pydantic schemas for agents, conversations, and API interactions in Swarms
- [SequentialWorkflow](https://docs.swarms.world/api/sequential-workflow.md): A workflow system for executing agents in a sequential, ordered chain
- [SpreadSheetSwarm](https://docs.swarms.world/api/spreadsheet-swarm.md): A swarm that processes tasks concurrently using multiple agents and saves metadata to CSV files
- [SwarmRouter](https://docs.swarms.world/api/swarm-router.md): A dynamic router that routes tasks to different swarm types based on user selection or automatic matching
- [Tools & Utilities](https://docs.swarms.world/api/tools.md): Comprehensive reference for Swarms tools, function calling, and schema conversion utilities
- [Utilities](https://docs.swarms.world/api/utils.md): Essential utility functions and classes for file processing, logging, formatting, and token management
- [Agent Rearrange](https://docs.swarms.world/architectures/agent-rearrange.md): Define complex multi-agent workflows with custom flow patterns using arrow and comma syntax
- [Concurrent Workflow](https://docs.swarms.world/architectures/concurrent-workflow.md): Execute multiple agents simultaneously for maximum throughput and parallel processing
- [Graph Workflow](https://docs.swarms.world/architectures/graph-workflow.md): Orchestrate complex agent workflows using Directed Acyclic Graphs (DAGs) with parallel and sequential execution
- [Group Chat](https://docs.swarms.world/architectures/group-chat.md): Enable collaborative multi-agent conversations with flexible speaker selection and interactive sessions
- [Heavy Swarm](https://docs.swarms.world/architectures/heavy-swarm.md): Sophisticated 5-phase analysis workflow with specialized agents for comprehensive research and insights
- [Hierarchical Swarm](https://docs.swarms.world/architectures/hierarchical-swarm.md): Director-worker pattern where a central director coordinates specialized agents with feedback loops
- [Mixture of Agents](https://docs.swarms.world/architectures/mixture-of-agents.md): Synthesize outputs from multiple expert agents using an aggregator for state-of-the-art performance
- [Multi-Agent Architectures Overview](https://docs.swarms.world/architectures/overview.md): Comprehensive guide to all multi-agent architectures in Swarms with comparison table and use cases
- [Sequential Workflow](https://docs.swarms.world/architectures/sequential-workflow.md): Execute agents in a linear chain where each agent's output becomes the next agent's input
- [Social Algorithms](https://docs.swarms.world/architectures/social-algorithms.md): Define and execute custom communication patterns between agents with arbitrary social algorithms
- [Swarm Router](https://docs.swarms.world/architectures/swarm-router.md): Universal orchestrator providing a single interface to dynamically select and execute any swarm type
- [CLI Commands](https://docs.swarms.world/cli/commands.md): Complete reference for all Swarms CLI commands with examples and parameters
- [CLI Configuration](https://docs.swarms.world/cli/configuration.md): Configure agents and swarms using YAML files and environment variables
- [CLI Overview](https://docs.swarms.world/cli/overview.md): Introduction to the Swarms Command-Line Interface for managing agents and swarms
- [Code of Conduct](https://docs.swarms.world/community/code-of-conduct.md): Community guidelines and standards for the Swarms framework
- [Contributing to Swarms](https://docs.swarms.world/community/contributing.md): Learn how to contribute to the Swarms framework and help build the future of multi-agent AI systems
- [Contributing to this documentation](https://docs.swarms.world/community/contributing-to-docs.md): How to propose changes, preview locally, and open pull requests for the Swarms documentation site
- [Development Setup](https://docs.swarms.world/community/development-setup.md): Set up your local development environment for contributing to Swarms
- [Join Our Discord Community](https://docs.swarms.world/community/discord.md): Connect with the Swarms community on Discord for support, discussions, and collaboration
- [Frequently Asked Questions](https://docs.swarms.world/community/faq.md): Common questions and troubleshooting for the Swarms framework
- [GitHub Repository](https://docs.swarms.world/community/github.md): Learn how to use GitHub to report issues, request features, and contribute to Swarms
- [Agents](https://docs.swarms.world/concepts/agents.md): Understanding the fundamental building block of Swarms - the Agent
- [Swarms](https://docs.swarms.world/concepts/swarms.md): Understanding multi-agent collaboration and orchestration in Swarms
- [Tools](https://docs.swarms.world/concepts/tools.md): Understanding tools and tool integration in Swarms
- [Workflows](https://docs.swarms.world/concepts/workflows.md): Understanding workflow orchestration patterns in Swarms
- [Agent Orchestration Protocol (AOP)](https://docs.swarms.world/deployment/agent-orchestration-protocol.md): Deploy and manage agents as distributed services with the Agent Orchestration Protocol
- [Monitoring & Observability](https://docs.swarms.world/deployment/monitoring.md): Monitor agent performance, track metrics, and gain observability into your Swarms deployment
- [Production Best Practices](https://docs.swarms.world/deployment/production-best-practices.md): Essential practices for deploying Swarms agents in production environments
- [Scaling Swarms](https://docs.swarms.world/deployment/scaling.md): Scale your multi-agent systems horizontally with concurrent and parallel execution
- [Environment Setup](https://docs.swarms.world/environment-setup.md): Configure API keys, workspace directory, and environment variables for Swarms
- [Agent with Tools](https://docs.swarms.world/examples/agent-with-tools.md): Enhance agents with external tools and function calling
- [Advanced Research](https://docs.swarms.world/examples/agents/advanced-research.md): Multi-agent orchestrator-worker research system with parallel execution and LLM-as-judge evaluation.
- [Agent Streaming](https://docs.swarms.world/examples/agents/agent-streaming.md): Stream agent responses in real-time, token by token, for an interactive UX.
- [Autonomous Looper with Bash](https://docs.swarms.world/examples/agents/autonomous-looper-bash.md): Run an autonomous agent loop that can execute bash commands to complete long-horizon tasks.
- [Autonomous Looper with Tools](https://docs.swarms.world/examples/agents/autonomous-looper-tools.md): Build an autonomous looping agent that uses tools to iteratively achieve a goal.
- [Gold ETF Research](https://docs.swarms.world/examples/applications/gold-etf-research.md): Research and analyze gold ETFs with a specialized financial-analysis swarm.
- [Hiring Swarm](https://docs.swarms.world/examples/applications/hiring-swarm.md): End-to-end hiring pipeline: source candidates, screen resumes, and run technical evaluations with agents.
- [Job Finding Swarm](https://docs.swarms.world/examples/applications/job-finding.md): Use a swarm to discover, filter, and apply to jobs that match a candidate profile.
- [M&A Swarm](https://docs.swarms.world/examples/applications/ma-swarm.md): Mergers and acquisitions analysis swarm covering deal sourcing, diligence, and valuation.
- [Marketing Team Swarm](https://docs.swarms.world/examples/applications/marketing-team.md): A full-stack marketing team of agents handling strategy, copy, design, and analytics.
- [Real Estate Swarm](https://docs.swarms.world/examples/applications/realestate-swarm.md): Real estate research, valuation, and deal-analysis swarm for residential and commercial properties.
- [Smart Database Swarm](https://docs.swarms.world/examples/applications/smart-database.md): An agent-powered intelligent database that queries, analyzes, and reasons over structured data.
- [Basic Agent](https://docs.swarms.world/examples/basic-agent.md): Create your first autonomous agent with Swarms
- [Chat Command](https://docs.swarms.world/examples/cli/chat-command.md): Launch an interactive chat session with a Swarms agent from the command line.
- [Multi-Agent CLI Quickstart](https://docs.swarms.world/examples/cli/multi-agent-quickstart.md): Spin up a multi-agent system from the Swarms CLI in under a minute.
- [Concurrent Workflow Example](https://docs.swarms.world/examples/concurrent-workflow-example.md): Learn how to run multiple agents simultaneously for maximum efficiency with parallel execution
- [Agentic Trading with Gemini](https://docs.swarms.world/examples/finance/agentic-trading-gemini.md): Build an autonomous crypto trading system using Swarms and the Gemini exchange API.
- [Group Chat Example](https://docs.swarms.world/examples/group-chat-example.md): Learn how to create conversational collaboration between agents for real-time decision-making and debates
- [Hierarchical Swarm Example](https://docs.swarms.world/examples/hierarchical-swarm-example.md): Learn how to use a director-worker pattern for complex project management and team coordination
- [Browser Use](https://docs.swarms.world/examples/integrations/browser-use.md): Drive a real browser from your agents to automate web workflows end to end.
- [Web Search with Exa](https://docs.swarms.world/examples/integrations/exa-search.md): Give your agents real-time web search using the Exa API for up-to-date knowledge.
- [MCP with DataStax](https://docs.swarms.world/examples/integrations/mcp-datastax.md): Connect Swarms agents to DataStax Astra DB through the Model Context Protocol (MCP).
- [x402 Discovery Query](https://docs.swarms.world/examples/integrations/x402-discovery.md): Discover and query x402-enabled services from your Swarms agents.
- [x402 Payment Integration](https://docs.swarms.world/examples/integrations/x402-payment.md): Integrate x402 native payments so agents can transact for paid services.
- [Mixture of Agents (MoA) Example](https://docs.swarms.world/examples/mixture-of-agents-example.md): Learn how to use multiple expert agents in parallel and synthesize their outputs for state-of-the-art results
- [AOP Medical Swarm](https://docs.swarms.world/examples/multi-agent/aop-medical.md): Run a medical-grade multi-agent system using the Agent Orchestration Protocol (AOP).
- [Debate Swarm Quickstart](https://docs.swarms.world/examples/multi-agent/debate-quickstart.md): Spin up a multi-agent debate where specialized agents argue and converge on conclusions.
- [AOP Examples Overview](https://docs.swarms.world/examples/overviews/aop-overview.md): Overview of Agent Orchestration Protocol (AOP) examples and patterns.
- [Applications Overview](https://docs.swarms.world/examples/overviews/applications-overview.md): Real-world Swarms applications across finance, healthcare, marketing, and research.
- [Apps Overview](https://docs.swarms.world/examples/overviews/apps-overview.md): Index of full applications built with the Swarms framework.
- [Basic Examples Overview](https://docs.swarms.world/examples/overviews/basic-overview.md): Starter examples covering the essentials: single agents, tools, streaming, and vision.
- [CLI Guides Overview](https://docs.swarms.world/examples/overviews/cli-overview.md): Index of guides for using the Swarms command-line interface.
- [Community Resources](https://docs.swarms.world/examples/overviews/community-resources.md): Community-maintained tutorials, blog posts, videos, and example repositories.
- [Swarms Cookbook](https://docs.swarms.world/examples/overviews/cookbook.md): Categorized cookbook of Swarms recipes by industry: finance, healthcare, marketing, and more.
- [Examples Index](https://docs.swarms.world/examples/overviews/examples-index.md): Curated index of 100+ Swarms examples across single agents, multi-agent systems, and industry applications.
- [Multi-Agent Architectures Overview](https://docs.swarms.world/examples/overviews/multi-agent-overview.md): Tour of multi-agent architectures: sequential, concurrent, hierarchical, mixture-of-agents, and more.
- [Paper Implementations](https://docs.swarms.world/examples/overviews/paper-implementations.md): Swarms implementations of influential AI research papers.
- [RAG Examples Overview](https://docs.swarms.world/examples/overviews/rag-overview.md): Retrieval-augmented generation patterns and examples built with Swarms.
- [Templates & Applications](https://docs.swarms.world/examples/overviews/templates.md): Production-ready templates and applications across healthcare, finance, research, and business.
- [Tools & Integrations Overview](https://docs.swarms.world/examples/overviews/tools-overview.md): Overview of tools and third-party integrations available to Swarms agents.
- [Sequential Workflow Example](https://docs.swarms.world/examples/sequential-workflow-example.md): Learn how to build sequential agent workflows where agents execute tasks in a linear chain
- [Streaming Responses](https://docs.swarms.world/examples/streaming.md): Stream agent outputs in real-time for better user experience
- [Content Creation Pipeline](https://docs.swarms.world/examples/use-cases/content-creation.md): Build an automated content creation pipeline with ideation, writing, editing, and review stages
- [Data Analysis Swarm](https://docs.swarms.world/examples/use-cases/data-analysis.md): Build a data analysis swarm that collects, analyzes, visualizes, and reports on complex datasets
- [Financial Analysis System](https://docs.swarms.world/examples/use-cases/financial-analysis.md): Build a comprehensive financial analysis system with market analysis, risk assessment, and investment recommendations
- [Research Team Swarm](https://docs.swarms.world/examples/use-cases/research-team.md): Build an autonomous research team that collaborates to produce comprehensive research reports
- [Vision Agent](https://docs.swarms.world/examples/vision-agent.md): Create agents that process images and multimodal content
- [Installation](https://docs.swarms.world/installation.md): Install Swarms using pip, uv, poetry, or from source
- [Swarms Marketplace](https://docs.swarms.world/integrations/marketplace.md): Discover, share, and monetize production-ready prompts and agents through the Swarms Marketplace
- [Model Context Protocol (MCP)](https://docs.swarms.world/integrations/mcp.md): Connect Swarms agents to MCP servers for dynamic tool discovery and execution
- [Model Providers](https://docs.swarms.world/integrations/model-providers.md): Integrate Swarms with multiple LLM providers including OpenAI, Anthropic, Groq, and more
- [Tools Integration](https://docs.swarms.world/integrations/tools.md): Add custom tools and functions to your Swarms agents for extended capabilities
- [Introduction to Swarms](https://docs.swarms.world/introduction.md): The Enterprise-Grade Production-Ready Multi-Agent Orchestration Framework
- [Quickstart Guide](https://docs.swarms.world/quickstart.md): Create your first agent and swarm in minutes