Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A complete, categorized catalog of every hands-on Swarms example in these docs, single agents, multi-agent systems, model providers, integrations, applications, and deployment.
| Category | What it covers |
|---|---|
| Basics | Your first agent, tools, vision, and streaming |
| Single-Agent Capabilities | Memory, autonomy, context management, token usage, scheduling |
| Reasoning Agents | Tree of Thoughts search over reasoning steps |
| Multi-Agent Architectures | Sequential, concurrent, hierarchical, group chat, routing |
| Model Providers | Run agents on any LLM provider |
| Voice Agents | Speech-enabled agents with TTS and STT |
| Tools & Integrations | Browser use, computer use, web search, MCP, payments |
| Applications | Full end-to-end swarms for real-world domains |
| Use Cases | Reusable multi-stage workflow patterns |
| Finance | Trading, prediction markets, and financial research |
| Research & Papers | Swarms implementations of research papers |
| Deployment | Ship agents to production |
| CLI | Drive agents from the command line |
| Example | Description | Link |
|---|---|---|
| Basic Agent | Create your first autonomous agent with Swarms | View Example |
| Agent with Tools | Enhance agents with external tools and function calling | View Example |
| Vision Agent | Create agents that process images and multimodal content | View Example |
| Streaming Responses | Stream agent outputs in real-time for better UX | View Example |
| Agent Streaming Example | Real-time token streaming with run_stream and arun_stream | View Example |
| Example | Description | Link |
|---|---|---|
| Agent Streaming | Stream agent responses token by token for an interactive UX | View Example |
| Advanced Research | Orchestrator-worker research system with parallel execution and LLM-as-judge | View Example |
| Autonomous Looper with Bash | An autonomous loop that runs bash commands for long-horizon tasks | View Example |
| Autonomous Looper with Tools | An autonomous looping agent that uses tools to iteratively reach a goal | View Example |
| Persistent Memory | Persist interaction history to disk and resume across restarts | View Example |
| Context Compression | Summarize memory near the context limit while archiving the full transcript | View Example |
| Prompt Caching | Cache a large, stable system prompt so repeat calls are billed at a discount | View Example |
| Autonomous Mode | How max_loops="auto" plans, executes subtasks, and summarizes | View Guide |
| Token Usage | Read provider token counts with agent.usage and size the next request with agent.input_tokens | View Guide |
| CronJob Quickstart | Put one agent on a schedule and keep it running | View Example |
| CronJob: Multiple Agents | Run several agents together, each on its own cadence | View Example |
| CronJob: Failure Handling | Keep a long-running schedule alive through failures | View Example |
TreeOfThoughts searches a tree of reasoning steps with BFS or DFS. See the Tree of Thoughts reference.
| Example | Description | Link |
|---|---|---|
| Number Theory with a BFS Beam | Count solutions with a breadth-first beam and averaged ratings per step | View Example |
| Fermi Estimate with Sampling and Votes | Independently sampled steps compared by vote | View Example |
| Knights and Knaves with DFS | Assume a case, follow it, and backtrack on a contradiction | View Example |
| Example | Description | Link |
|---|---|---|
| Sequential Workflow | Agents execute tasks in a linear chain | View Example |
| Sequential Workflow Streaming | Real-time token streaming across a pipeline of agents | View Example |
| Concurrent Workflow | Run multiple agents simultaneously for maximum efficiency | View Example |
| Mixture of Agents (MoA) | Run expert agents in parallel and synthesize their outputs | View Example |
| Hierarchical Swarm | Director-worker pattern for complex project coordination | View Example |
| Group Chat | Turn-based, self-selecting agent group chat for debate and reasoning | View Example |
| Swarm Router | Switch between any multi-agent architecture by changing one parameter | View Example |
| Social Swarm Patterns | Broadcast, circular, mesh, grid, star, pyramid, and aggregate patterns | View Example |
| Advisor Swarm | Pair a cheap executor model with a powerful advisor consulted on-demand | View Example |
| Debate Swarm Quickstart | Specialized agents argue and converge on conclusions | View Example |
| GroupChat Internals | Deep technical analysis of the turn-based, self-selecting GroupChat module | View Example |
| Auto Agent Builder Quickstart | Turn a plain-English task into a working team of agents | View Example |
| Auto Agent Builder: Triage | Build a fresh team of specialists for every incoming ticket | View Example |
| Auto Agent Builder: Reproducible Rosters | Design a team once, then version and rerun it | View Example |
| Provider | Description | Link |
|---|---|---|
| Anthropic | Claude models — Fable 5, Opus, Sonnet, and Haiku | View Example |
| Claude Fable 5 | Anthropic Claude Fable 5 and Mythos 5 in Swarms | View Example |
| OpenAI | GPT and o-series models — GPT-5.4, GPT-4.1, o3, o3-mini | View Example |
| Gemini | Google Gemini — 2.5 Pro, 2.5 Flash, and Flash-Lite | View Example |
| Groq | Ultra-fast inference — Llama, GPT-OSS, DeepSeek R1, Kimi K2 | View Example |
| Cerebras | The fastest open-model inference — 1000+ tokens/sec | View Example |
| DeepSeek | DeepSeek models, including the DeepSeek Reasoner (R1) | View Example |
| xAI (Grok) | xAI Grok models — Grok 4 and earlier | View Example |
| Ollama | Local models with no API key and no per-token cost | View Example |
| vLLM | Self-host open-source models for high-throughput production inference | View Example |
| OpenRouter | One API key, hundreds of models across providers | View Example |
| OpenRouter Tutorial | Single agents, group chat, and concurrent workflows via OpenRouter | View Example |
| Azure OpenAI | Enterprise-grade GPT models through Microsoft Azure | View Example |
| Example | Description | Link |
|---|---|---|
| Basic Speech Agent | Run an agent, then narrate its final response with text-to-speech | View Example |
| Streaming Voice Agent | Speak each sentence the moment the LLM produces it | View Example |
| Autonomous Voice Agent | An autonomous agent that narrates its plan, tool use, and summary | View Example |
| Voice Debate | Two agents debate turn-by-turn, each with a distinct voice | View Example |
| Hierarchical Speech Swarm | Director and workers each speak with a distinct voice | View Example |
| Example | Description | Link |
|---|---|---|
| Browser Use | Drive a real browser to automate web workflows end to end | View Example |
| Web Scraper Agents | Navigate sites and extract structured data in parallel | View Example |
| Web Search with Exa | Give agents real-time web search via the Exa API | View Example |
| Firecrawl Tool | Crawl entire websites and extract structured content | View Example |
| MCP with DataStax | Connect agents to Astra DB through the Model Context Protocol | View Example |
| MCP tool integrations | Connect agents to real MCP servers: DeepWiki, Exa, Firecrawl, Hugging Face, Semgrep | View Examples |
| Serve an Agent over MCP | Put one agent behind an API key with MCPDeployer and call it from another agent | View Example |
| Serve a Team over MCP | Expose several agents, a workflow, and a function as tools on one MCP server | View Example |
| Dynamic Tool Usage | Defer tool schemas behind a searchable catalog with dynamic_tools=True | View Example |
| DecisionModel | Ask a decision model (TypeSafe Jev, Cloudflare Clef) typed questions about a state | View Reference |
| x402 Discovery Query | Discover and query x402-enabled services | View Example |
| x402 Payment Integration | Let agents transact natively for paid services | View Example |
| Example | Description | Link |
|---|---|---|
| Marketing Team Swarm | Strategy, copy, design, and analytics handled by agents | View Example |
| Hiring Swarm | Source candidates, screen resumes, run technical evaluations | View Example |
| Job Finding Swarm | Discover, filter, and apply to jobs matching a profile | View Example |
| M&A Swarm | Deal sourcing, diligence, and valuation for mergers & acquisitions | View Example |
| Real Estate Swarm | Research, valuation, and deal analysis for properties | View Example |
| Smart Database Swarm | An agent-powered database that queries and reasons over data | View Example |
| Example | Description | Link |
|---|---|---|
| Research Team | An autonomous team that collaborates on comprehensive reports | View Example |
| Content Creation Pipeline | Ideation, writing, editing, and review stages | View Example |
| Data Analysis Swarm | Collect, analyze, visualize, and report on datasets | View Example |
| Financial Analysis System | Market analysis, risk assessment, and investment recommendations | View Example |
| Example | Description | Link |
|---|---|---|
| Gold ETF Research | Research and analyze gold ETFs with a financial-analysis swarm | View Example |
| Agentic Trading with Gemini | An autonomous crypto trading system using the Gemini exchange API | View Example |
| Prediction Markets: Polymarket | Agents that discover events, reason, and bet on Polymarket | View Example |
| Prediction Markets: Kalshi | Agents that discover events, reason, and bet on Kalshi | View Example |
| Example | Description | Link |
|---|---|---|
| Can AI Agents Agree? | The Byzantine consensus game from Berdoz, Rugli & Wattenhofer | View Example |
| Open Agent Bazaar | Measuring economic alignment in multi-agent marketplaces | View Example |
| Paper Implementations Index | The full list of paper implementations | View Index |
| Example | Description | Link |
|---|---|---|
| Deployment Overview | Choose the right deployment strategy for your agents | View Guide |
| FastAPI Agent API | Deploy agents as REST endpoints with FastAPI and Uvicorn | View Example |
| Google Cloud Run | Deploy a containerized agent REST API with automatic scaling | View Example |
| Cloudflare Workers | Deploy cron-driven agents on Cloudflare’s global edge network | View Example |
| Phala TEE Deployment | Deploy inside a Trusted Execution Environment with on-chain attestation | View Example |
| MCPDeployer | Serve agents and swarms as an authenticated MCP server | View Reference |
| Example | Description | Link |
|---|---|---|
| CLI Quickstart Tutorial | Build a multi-agent research-and-writing workflow using only the CLI | View Example |
| Chat Command | Launch an interactive chat session with an agent | View Example |
| Multi-Agent CLI Quickstart | Spin up a multi-agent system from the CLI in under a minute | View Example |
Was this page helpful?