> ## 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.

# Welcome

> Overview of the Swarms API: endpoints, agents, multi-agent architectures, and where to start.

The Swarms API is the most advanced platform for building multi-agent systems.

If you're creating a single intelligent agent or orchestrating thousands of agents in complex workflows, Swarms provides the tools, infrastructure, and runtime you need to bring your agents into production.

## Platform Benefits

Swarms API is designed for developers who need more than just a simple AI completion endpoint. We provide a complete ecosystem for building, deploying, and scaling intelligent AI systems that can collaborate, reason, and solve complex problems together.

<Columns cols={3}>
  <Card title="Multi-Agent Architectures" href="/docs/documentation/multi-agent/available-architectures">
    Build hierarchical, sequential, and parallel agent systems with up to 2,000 agents per swarm.
  </Card>

  <Card title="Agent-to-Agent Communication" href="/docs/documentation/multi-agent/overview">
    Protocols enabling seamless coordination and knowledge sharing across agents.
  </Card>

  <Card title="Optimized Execution Runtime" href="/docs/documentation/getting-started/architecture">
    High-performance, concurrent runtime optimized for resource efficiency.
  </Card>
</Columns>

<Columns cols={3}>
  <Card title="Multi-Agent Memory" href="/docs/documentation/multi-agent/hierarchical_swarm">
    Persistent, shareable memory for complex workflows and long-lived context.
  </Card>

  <Card title="Simulation Environments" href="/docs/documentation/multi-agent/concurrent_workflow">
    Test and validate swarms in controlled environments before production.
  </Card>

  <Card title="Security & Compliance" href="/docs/documentation/resources/technical-support">
    Enterprise-grade security, governance, and reliability.
  </Card>
</Columns>

## Getting Started

### Essential Setup

<Columns cols={3}>
  <Card title="API Key Setup" href="https://swarms.world/platform/api-keys" cta="Get your key">
    Create your API key and configure authentication.
  </Card>

  <Card title="Quickstart" href="/docs/documentation/getting-started/quickstart">
    Build your first agent in under 5 minutes.
  </Card>

  <Card title="Configuration" href="/docs/documentation/getting-started/setup">
    Set up your development environment.
  </Card>
</Columns>

### Core Architecture

<Columns cols={3}>
  <Card title="API Architecture" href="/docs/documentation/getting-started/architecture">
    Three-tier architecture for scalable AI operations.
  </Card>

  <Card title="Client Libraries" href="/docs/documentation/resources/client-libraries">
    Official SDKs for Python, TypeScript, Go, Java, and more.
  </Card>

  <Card title="Swarm Types" href="/docs/documentation/multi-agent/available-architectures">
    Explore different swarm configurations and patterns.
  </Card>
</Columns>

### Workflow Patterns

<Columns cols={3}>
  <Card title="Sequential Workflows" href="/docs/documentation/multi-agent/sequential_workflow">
    Chain agents for step-by-step processing.
  </Card>

  <Card title="Concurrent Workflows" href="/docs/documentation/multi-agent/concurrent_workflow">
    Run agents in parallel for maximum throughput.
  </Card>

  <Card title="Hierarchical Swarms" href="/docs/documentation/multi-agent/hierarchical_swarm">
    Build agent hierarchies for complex decision-making.
  </Card>
</Columns>

<Columns cols={3}>
  <Card title="Multi-Agent Router" href="/docs/documentation/multi-agent/multi_agent_router">
    Intelligent routing and load balancing.
  </Card>

  <Card title="Mixture of Agents" href="/docs/documentation/multi-agent/mixture_of_agents">
    Combine specialist agents for better results.
  </Card>

  <Card title="Majority Voting" href="/docs/documentation/multi-agent/majority_voting">
    Consensus-based decision making.
  </Card>
</Columns>

<Columns cols={3}>
  <Card title="Agent Rearrange" href="/docs/documentation/multi-agent/agent_rearrange">
    Dynamically reconfigure active agents.
  </Card>
</Columns>

## Advanced Capabilities

<Columns cols={2}>
  <Card title="Structured Outputs" href="/docs/documentation/capabilities/swarms_api_tools">
    Generate structured data with validation.
  </Card>

  <Card title="MCP Integration" href="/docs/documentation/capabilities/mcp_integration">
    Model Context Protocol for enhanced interactions.
  </Card>
</Columns>

## API Endpoint Overview

Base URL: `https://api.swarms.world`. All endpoints except `/` and `/health` require the `x-api-key` header (`Authorization: Bearer <key>` is also accepted). Endpoints marked Premium require a Pro, Ultra, or Premium subscription; call `GET /v1/account/premium-endpoints` for the live list.

| Method | Endpoint | Premium | Description |
| - | - | - | - |
| GET | `/` | No | API root / welcome message |
| GET | `/health` | No | Health check |
| POST | `/v1/agent/completions` | No | Single agent completion |
| POST | `/v1/agent/batch/completions` | Yes | Batch agent completions (up to 50 per request) |
| POST | `/v1/swarm/completions` | No | Multi-agent swarm completion |
| POST | `/v1/swarm/batch/completions` | Yes | Batch swarm completions |
| POST | `/v1/chat/completions` | No | OpenAI-compatible chat completions |
| GET | `/v1/models` | No | OpenAI-compatible model list |
| GET | `/v1/models/available` | No | Available models with metadata |
| POST | `/v1/reasoning-agent/completions` | Yes | Reasoning agent completion |
| GET | `/v1/reasoning-agent/types` | No | List available reasoning agent types |
| GET | `/v1/swarms/available` | No | List swarm types and their metadata |
| GET | `/v1/account/logs` | No | API request logs for your account |
| GET | `/v1/account/metrics/summary` | No | Usage metrics summary |
| GET | `/v1/account/premium-endpoints` | No | List endpoints that require Premium |
| GET | `/v1/account/credits` | No | Credit balance |
| GET | `/v1/agents/list` | No | List your saved agent configurations |
| GET | `/v1/rate/limits` | No | Current rate limit status and usage |
| GET | `/v1/tools/available` | No | List built-in tools (`auto_search`, `web_scraper`) |
| GET | `/v1/usage/costs` | No | Full pricing details |
| POST | `/v1/batched-grid-workflow/completions` | Yes | Batched grid workflow (agents x tasks) |
| POST | `/v1/graph-workflow/completions` | Yes | Directed-graph multi-agent workflow |
| POST | `/v1/auto-agent-builder/completions` | No | Generate an agent roster for a task (does not execute it) |

## Resources & Support

<Columns cols={3}>
  <Card title="Rate Limits" href="/docs/documentation/resources/ratelimits">
    API usage limits and quotas.
  </Card>

  <Card title="Pricing" href="/docs/documentation/resources/pricing">
    Transparent pricing structure.
  </Card>

  <Card title="Community" href="/docs/documentation/resources/community">
    Join our developer community.
  </Card>
</Columns>

<Columns cols={3}>
  <Card title="Technical Support" href="/docs/documentation/resources/technical-support">
    Enterprise support and troubleshooting.
  </Card>

  <Card title="API Reference" href="https://api.swarms.world/openapi.json" cta="Open reference">
    Complete OpenAPI specification.
  </Card>

  <Card title="API Cookbook" href="https://github.com/The-Swarm-Corporation/swarms-api-cookbook" cta="Open on GitHub">
    Practical, runnable examples for agents, workflows, and utilities.
  </Card>
</Columns>

## Ready to Build?

Join thousands of developers building the future of AI with Swarms API. Start with our comprehensive documentation, explore our examples, and join our community.

<Columns cols={3}>
  <Card title="Get Started Now" href="/docs/documentation/getting-started/quickstart" cta="Quickstart">
    Build your first agent in minutes.
  </Card>

  <Card title="API Reference" href="https://api.swarms.world/openapi.json" cta="Open reference">
    Explore the full API specification.
  </Card>

  <Card title="Join Our Community" href="https://discord.gg/EamjgSaEQf" cta="Join Discord">
    Connect with developers and get help.
  </Card>
</Columns>

***

*Built with dedication by [The Swarm Corporation](https://swarms.ai)*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.