# Swarms API Documentation

> Build intelligent AI agents and multi-agent swarms with the Swarms API. Create single agents, reasoning systems, and enterprise-scale swarms for automation, research, and complex problem-solving.

## Docs

- [Introduction](https://docs.swarms.ai/docs/introduction/overview.md): Welcome to The Swarm Corporation - Building the infrastructure for the agent economy
- [Our Mission](https://docs.swarms.ai/docs/introduction/our-mission.md): Building the infrastructure for the agent economy enabling autonomous AI agents to transform how we work, create, and solve problems
- [Our Products](https://docs.swarms.ai/docs/introduction/our-products.md): Explore Swarms API and Swarms Marketplace - the infrastructure powering the agent economy
- [Links and Resources](https://docs.swarms.ai/docs/introduction/links-and-resources.md): All social media links, website links, and resources for The Swarm Corporation
- [Design Philosophy](https://docs.swarms.ai/docs/introduction/design-philosophy.md): The principles and values that guide how we build the Swarms API platform and shape the agent economy.
- [Join Our Team](https://docs.swarms.ai/docs/introduction/hiring.md): Help us build the agent economy. We are hiring talented individuals who are passionate about AI, agents, and creating the future of work.
- [Welcome](https://docs.swarms.ai/docs/documentation/index.md)
- [FAQ](https://docs.swarms.ai/docs/documentation/faq.md): Get answers to the most common questions about the Swarms API platform, pricing, capabilities, and implementation.
- [Quickstart](https://docs.swarms.ai/docs/documentation/getting-started/quickstart.md): The Swarms API enables you to create and orchestrate AI agents for both single-agent tasks and multi-agent workflows.
- [API Key Setup](https://docs.swarms.ai/docs/documentation/getting-started/api-key-setup.md): This guide provides step-by-step instructions for obtaining and configuring your Swarms API key to access the Swarms platform services.
- [Setup & Configuration](https://docs.swarms.ai/docs/documentation/getting-started/setup.md): Complete setup guide for the Swarms API. Learn how to configure authentication, set up your development environment, and start building with our multi-agent swarm platform.
- [API Architecture](https://docs.swarms.ai/docs/documentation/getting-started/architecture.md): The Swarms API provides a comprehensive multi-tier architecture for building collaborative agentic systems.
- [Official Client Libraries](https://docs.swarms.ai/docs/documentation/resources/client-libraries.md): Discover official SDKs and client libraries for the Swarms API in multiple programming languages.
- [Python Client](https://docs.swarms.ai/docs/documentation/clients/python-client.md): Official Python client library for the Swarms API with comprehensive features and examples
- [Swarms API MCP Server](https://docs.swarms.ai/docs/documentation/clients/swarms-api-mcp.md): Connect MCP-compatible agents and applications to Swarms AI through the Model Context Protocol. Execute agents, orchestrate swarms, run reasoning workflows, and process batches—all via a standardized MCP interface.
- [Docs MCP and LLMs txt](https://docs.swarms.ai/docs/documentation/clients/swarms-docs-mcp.md): Give any coding agent Claude Code, Cursor, Codex, Windsurf, and more instant access to the Swarms API documentation via MCP or llms.txt.
- [Agent Completions Reference](https://docs.swarms.ai/docs/documentation/capabilities/agent.md): Learn how to build individual agents and their capabilities with swarms
- [OpenAI-Compatible Endpoint](https://docs.swarms.ai/docs/documentation/capabilities/openai-compatible.md): Complete API reference for the /v1/chat/completions endpoint — a drop-in replacement for the OpenAI API that routes through Swarms agent infrastructure.
- [Multi-Agent Overview](https://docs.swarms.ai/docs/documentation/multi-agent/overview.md): Comprehensive guide to multi-agent systems, swarm types, best practices, and the Swarm Completions API endpoint
- [Available Multi-Agent Architectures](https://docs.swarms.ai/docs/documentation/multi-agent/available-architectures.md): Comprehensive reference of all available multi-agent swarm architectures in the Swarms API
- [SequentialWorkflow](https://docs.swarms.ai/docs/documentation/multi-agent/sequential_workflow.md): Execute tasks in a strict, predefined order for step-by-step processing with dependencies between steps
- [ConcurrentWorkflow](https://docs.swarms.ai/docs/documentation/multi-agent/concurrent_workflow.md): Parallel execution swarm that runs independent tasks simultaneously for faster processing and improved efficiency
- [MultiAgentRouter](https://docs.swarms.ai/docs/documentation/multi-agent/multi_agent_router.md): Intelligent task dispatcher that distributes work based on agent capabilities and workload optimization
- [MixtureOfAgents](https://docs.swarms.ai/docs/documentation/multi-agent/mixture_of_agents.md): Collaborative swarm where multiple agents work together on the same task, combining their expertise for comprehensive solutions
- [GroupChat](https://docs.swarms.ai/docs/documentation/multi-agent/group_chat.md): Collaborative discussion swarm where multiple agents engage in group conversation, building on each other's ideas for brainstorming and cross-functional planning
- [MajorityVoting](https://docs.swarms.ai/docs/documentation/multi-agent/majority_voting.md): Democratic decision-making swarm where multiple agents vote on solutions, with the majority determining the final outcome
- [HierarchicalSwarm](https://docs.swarms.ai/docs/documentation/multi-agent/hierarchical_swarm.md): Multi-level swarm architecture with supervisor agents coordinating specialized worker agents in a hierarchical structure
- [AgentRearrange](https://docs.swarms.ai/docs/documentation/multi-agent/agent_rearrange.md): Dynamic swarm architecture that can reorganize agent roles and responsibilities based on task requirements and performance
- [GraphWorkflow](https://docs.swarms.ai/docs/documentation/multi-agent/graph_workflow.md): The Graph Workflow API enables you to create and execute complex multi-agent workflows using a directed graph structure. Agents serve as nodes in the graph, and edges define the flow of data and execution between agents. This allows for sophisticated parallel processing, sequential pipelines, and co…
- [Auto Agent Builder](https://docs.swarms.ai/docs/documentation/multi-agent/auto_agent_builder.md): The Auto Agent Builder API generates a ready-to-run roster of agent configurations from a plain-language task description. A single builder agent analyzes your task and designs the team — names, descriptions, system prompts, and model choices — returning JSON configs you can post directly to the mul…
- [DebateWithJudge](https://docs.swarms.ai/docs/documentation/multi-agent/debate_with_judge.md): Structured debate architecture where a Pro agent and Con agent present opposing arguments, evaluated and synthesized by an impartial Judge agent through progressive refinement loops
- [HeavySwarm](https://docs.swarms.ai/docs/documentation/multi-agent/heavy_swarm.md): High-capacity multi-agent swarm that decomposes complex tasks into specialized questions and executes them using five specialized agents for comprehensive analysis
- [RoundRobin](https://docs.swarms.ai/docs/documentation/multi-agent/round_robin.md): Randomized round-robin task distribution where agents take turns collaborating with full conversation context
- [Batch Agent Completions (Single Agent)](https://docs.swarms.ai/docs/examples/examples/batch-processing.md): Process multiple single-agent tasks efficiently in parallel using the /v1/agent/batch/completions endpoint.
- [Batch Agent Completions at Scale](https://docs.swarms.ai/docs/examples/examples/batch-agent-scale-tutorial.md): Score 10,000 sales leads or triage 10,000 support tickets in a single batch call. The throughput-and-cost story for /v1/agent/batch/completions.
- [Batch Swarm Completions (Multi-Agent)](https://docs.swarms.ai/docs/examples/examples/batch-swarm-completions.md): Execute multiple multi-agent swarm workflows in parallel using the /v1/swarm/batch/completions endpoint.
- [Batch Swarm Completions for Overnight Reports](https://docs.swarms.ai/docs/examples/examples/batch-swarm-scale-tutorial.md): Run 50 separate due-diligence swarms as one overnight batch job using /v1/swarm/batch/completions. The enterprise scheduling pattern.
- [BatchedGridWorkflow](https://docs.swarms.ai/docs/documentation/multi-agent/batched_grid_workflow.md): Execute multiple tasks across multiple agents in a grid pattern, with each agent processing all tasks in parallel batches
- [Structured Outputs](https://docs.swarms.ai/docs/documentation/capabilities/swarms_api_tools.md): Get schema-enforced JSON output from your agents using response_format, and integrate tools for function calling
- [Sub-Agent Delegation](https://docs.swarms.ai/docs/documentation/capabilities/sub_agents.md): Enable agents to dynamically create and delegate tasks to specialized sub-agents at runtime
- [MCP Integration](https://docs.swarms.ai/docs/documentation/capabilities/mcp_integration.md): Integrate MCP Into your Agents
- [Streaming](https://docs.swarms.ai/docs/documentation/capabilities/tools.md): Real-time streaming responses for immediate agent feedback and better user experience
- [Fetch Previously Created Agents](https://docs.swarms.ai/docs/documentation/capabilities/agents_list.md): Retrieve all agents you have created via the API
- [User Metrics Summary](https://docs.swarms.ai/docs/documentation/capabilities/metrics_summary.md): Retrieve a summary of your core usage metrics in a single call
- [Overview](https://docs.swarms.ai/docs/documentation/resources/resources-overview.md): A comprehensive guide to all Swarms API resources, documentation, and support materials.
- [Rate Limits](https://docs.swarms.ai/docs/documentation/resources/ratelimits.md): The Swarms API implements a comprehensive rate limiting system that tracks API requests across multiple time windows and enforces various limits to ensure fair usage and system stability.
- [Rate Limit Headers](https://docs.swarms.ai/docs/documentation/resources/rate-limit-headers.md): Rate-limited API responses include X-RateLimit-* headers so you can track your usage and remaining quota in real time without making a separate API call.
- [Pricing](https://docs.swarms.ai/docs/documentation/resources/pricing.md): This page details the pricing structure and how credits are deducted for various API operations.
- [Usage Report](https://docs.swarms.ai/docs/documentation/resources/usage-report.md): API reference for the GET /v1/usage/costs endpoint — retrieve the current per-operation pricing used to calculate your usage costs.
- [Security](https://docs.swarms.ai/docs/documentation/resources/security.md): Swarms API security certifications and compliance standards. We take security very seriously.
- [Response Compression](https://docs.swarms.ai/docs/documentation/resources/response-compression.md): The Swarms API automatically compresses HTTP responses using fast algorithms (LZ4, GZip) to reduce payload size and improve response times.
- [Premium Endpoints](https://docs.swarms.ai/docs/documentation/resources/premium-endpoints.md): Endpoints available exclusively to Pro and Ultra plan members
- [Priority Processing](https://docs.swarms.ai/docs/documentation/resources/priority-processing.md): Learn how the Swarms API handles request priority for premium subscribers during high demand periods
- [Global Availability](https://docs.swarms.ai/docs/documentation/resources/global-availability.md): Swarms platform is now globally available across four regions for reduced latency and improved reliability.
- [Community](https://docs.swarms.ai/docs/documentation/resources/community.md): Connect with the Swarms community of agent engineers and researchers
- [Technical Support](https://docs.swarms.ai/docs/documentation/resources/technical-support.md): Get comprehensive technical support for Swarms API
- [Referral Program](https://docs.swarms.ai/docs/documentation/resources/referral.md): Refer friends and you’ll both earn $20 in complimentary Swarms credits
- [Contributors](https://docs.swarms.ai/docs/documentation/resources/contributors.md): Help us maintain and improve the Swarms API documentation, examples, and client libraries
- [Workflow Builder](https://docs.swarms.ai/docs/documentation/workflow-builder/overview.md): Visually design, run, and export multi-agent workflows on Swarms Cloud. Drag agents onto a canvas, connect them into a directed graph, then run on the platform or export the request as code.
- [Introduction](https://docs.swarms.ai/docs/marketplace/index.md): Welcome to the Swarms Platform for sharing, discovering, and hosting agents and agent swarms.
- [Overview](https://docs.swarms.ai/docs/marketplace/overview.md): The Swarms Marketplace - Building the world's largest marketplace of AI agents with effortless accessibility, discoverability, and integrated financial infrastructure
- [Agents vs Prompts](https://docs.swarms.ai/docs/marketplace/agents-vs-prompts.md): Understanding the differences between Agents and Prompts in the Swarms Marketplace
- [Bundles](https://docs.swarms.ai/docs/marketplace/bundles.md): Package agents and prompts into a single, shareable, reusable toolkit on the Swarms Marketplace
- [Share and Discover](https://docs.swarms.ai/docs/marketplace/share_and_discover.md): Discover community-built agents, prompts, and tools on the Swarms Marketplace.
- [Monetization Guide](https://docs.swarms.ai/docs/marketplace/monetize.md): Learn eligibility, pricing, and payout workflows for monetizing marketplace agents, prompts, and tools.
- [Marketplace Business Models](https://docs.swarms.ai/docs/marketplace/business-models.md): Every way to monetize on the Swarms Marketplace: crypto paid, fiat paid, tokenization, frenzy tokens, and vault mode, compared side by side.
- [Account Management](https://docs.swarms.ai/docs/marketplace/account_management.md): Manage account settings, profile data, billing, subscriptions, and wallet details on Swarms.
- [API Keys](https://docs.swarms.ai/docs/marketplace/apikeys.md): Create, manage, and secure API keys for programmatic access to your Swarms account.
- [Apps Page](https://docs.swarms.ai/docs/marketplace/apps_page.md): Customize sidebar apps, templates, and favorites from the Swarms Apps page.
- [Playground Page](https://docs.swarms.ai/docs/marketplace/playground_page.md): Use the Swarms Playground to test API requests and generate code in multiple languages.
- [Yuki Marketplace Companion](https://docs.swarms.ai/docs/marketplace/yuki.md): Learn how Yuki helps users navigate the Swarms Marketplace, understand products, and get live marketplace guidance.
- [Fiat Payments Overview](https://docs.swarms.ai/docs/marketplace/fiat-payments.md): Buy and sell AI agents and prompts with fiat on the Swarms Marketplace, powered by Stripe. 100+ countries, multi-currency support, Apple Pay, Google Pay, Alipay, crypto, and much more.
- [Vendor Tutorial: Sell with Fiat](https://docs.swarms.ai/docs/marketplace/fiat-payments-vendor-tutorial.md): Set up your Stripe seller account and publish paid agents and prompts that buyers can purchase by card. Payouts go straight to your bank.
- [Buyer Tutorial: Pay by Card](https://docs.swarms.ai/docs/marketplace/fiat-payments-buyer-tutorial.md): Purchase paid AI agents and prompts on the Swarms Marketplace with your card, Apple Pay, Google Pay, Alipay, and more, with instant, lifetime access.
- [Monetization Models](https://docs.swarms.ai/docs/marketplace/tokenization.md): Publish and monetize your AI agents, prompts, and tools on the Swarms Marketplace
- [Tokenization Details](https://docs.swarms.ai/docs/marketplace/tokenization_details.md): Learn about token creation costs and bonding curve progression for tokenized agents and prompts
- [Frenzy Mode](https://docs.swarms.ai/docs/marketplace/frenzy-mode.md): Double the bonding curve fees on your tokenized agent or prompt and earn a featured spot on the Frenzy leaderboard
- [Vault Mode](https://docs.swarms.ai/docs/marketplace/vault-mode.md): Token-gate your tokenized agents and prompts so only $TICKER holders can view the full listing
- [ACM Hackathon](https://docs.swarms.ai/docs/marketplace/acm-hackathon.md): Build, tokenize, and list agents or prompts on the Swarms Marketplace for a chance to earn ACM Hackathon rewards.
- [Creator Fees](https://docs.swarms.ai/docs/marketplace/creator-fees.md): Learn how creators earn fees from marketplace transactions
- [Revenue & Fees](https://docs.swarms.ai/docs/marketplace/revenue-fees.md): Understand Swarms' dynamic fee structure for marketplace transactions
- [Overview](https://docs.swarms.ai/docs/marketplace/api-overview.md): Quick reference for all Swarms Marketplace APIs - endpoints, methods, and authentication requirements
- [Marketplace Endpoints](https://docs.swarms.ai/docs/marketplace/user-marketplace-endpoints.md): Complete reference of Swarms Marketplace endpoints for managing your agents, prompts, products, fees, token launches, and reviews
- [List Products API](https://docs.swarms.ai/docs/marketplace/list-products-api.md): List every product you've posted to the Swarms Marketplace - agents, prompts, tools, and bundles
- [Product Fees API](https://docs.swarms.ai/docs/marketplace/product-fees-api.md): Check how much in creator fees a tokenized product has generated, via the Jupiter partner API
- [Agents API](https://docs.swarms.ai/docs/marketplace/agents-api.md): Easily create, update, and fetch agents in the Swarms marketplace in just 3 steps
- [Prompts API](https://docs.swarms.ai/docs/marketplace/prompts-api.md): Learn how to create, update, and fetch prompts in the Swarms marketplace
- [Bundles API](https://docs.swarms.ai/docs/marketplace/bundles-api.md): Publish bundles to the Swarms marketplace programmatically
- [Reviews API](https://docs.swarms.ai/docs/marketplace/reviews.md): Submit and retrieve star ratings and written reviews for agents, prompts, and tools listed on the Swarms marketplace
- [Token Launch API](https://docs.swarms.ai/docs/marketplace/token-launch-api.md): Create a minimal agent listing and launch an associated token on Solana in a single request
- [Frenzy Launch Example](https://docs.swarms.ai/docs/marketplace/token-launch-frenzy-example.md): Step-by-step guide to launching a tokenized agent in Frenzy mode with 2× bonding curve fees
- [Token Launch Batch API](https://docs.swarms.ai/docs/marketplace/token-launch-batch-api.md): Create multiple tokenized agents in a single request
- [Claim Fees API](https://docs.swarms.ai/docs/marketplace/claim-fees-api.md): Claim accumulated fees for a token on Solana
- [Marketplace Examples](https://docs.swarms.ai/docs/marketplace/examples.md): Complete examples for working with the Swarms marketplace API
- [Marketplace Examples Overview](https://docs.swarms.ai/docs/marketplace/marketplace_examples_overview.md): Overview of practical marketplace integration patterns for loading prompts and publishing agents.
- [Marketplace Prompt Loading](https://docs.swarms.ai/docs/marketplace/marketplace_prompt_loading.md): Load production-ready prompts from the Swarms Marketplace directly into your agents.
- [Self-Tokenizing Agents Tutorial on Swarms Launchpad](https://docs.swarms.ai/docs/marketplace/launchpad-tokenize-your-agent-tutorial.md): Launch a tokenized agent on Solana, publish it to the Swarms Marketplace, and enable autonomous revenue in four steps.
- [Marketplace Publishing Quickstart](https://docs.swarms.ai/docs/marketplace/marketplace_publishing_quickstart.md): Publish agents to the Swarms Marketplace quickly with required metadata and API key setup.
- [Launch Checklist](https://docs.swarms.ai/docs/marketplace/launch-checklist.md): Enterprise guide to successfully launching your agent on the Swarms Marketplace
- [Product image sizing (marketplace)](https://docs.swarms.ai/docs/marketplace/product_image_sizing.md): Recommended product (agent/prompt) banner image sizing for the Launch page and the entity page hero.
- [Swarms Foundry Program](https://docs.swarms.ai/docs/marketplace/foundry.md): Transform AI agent concepts into commercially viable, enterprise-scale businesses with infrastructure, funding, and integrated monetization
- [API Root](https://docs.swarms.ai/api-reference/general/api-root.md): Root endpoint providing API welcome message and links to documentation and API key management.
- [Health Check](https://docs.swarms.ai/api-reference/general/health-check.md): Health check endpoint to verify API service availability and operational status.
- [Get Available Swarm Types](https://docs.swarms.ai/api-reference/swarms/get-available-swarm-types.md): Retrieve all available swarm types supported by the Swarms API.
- [Execute Swarm Completion](https://docs.swarms.ai/api-reference/swarms/execute-swarm-completion.md): Execute a swarm completion with the specified task. Supports both standard and streaming responses.
- [Execute Batch Swarm Completions](https://docs.swarms.ai/api-reference/swarms/execute-batch-swarm-completions.md): Execute multiple swarm completions concurrently using optimized thread pool execution. This is a premium-only feature.
- [Chat Completions (OpenAI-compatible)](https://docs.swarms.ai/api-reference/openai-compatible/chat-completions-openai-compatible.md): OpenAI-compatible chat completions endpoint. Accepts the standard OpenAI request schema and returns the standard OpenAI response schema. Supports both streaming (SSE) and non-streaming modes. Works as a drop-in replacement with the OpenAI Python and TypeScript SDKs.
- [Execute Agent Completion](https://docs.swarms.ai/api-reference/agents/execute-agent-completion.md): Execute a single agent completion with the specified task. Supports both standard and streaming responses.
- [Execute Batch Agent Completions](https://docs.swarms.ai/api-reference/agents/execute-batch-agent-completions.md): Execute multiple agent completions concurrently using optimized thread pool execution. This is a premium-only feature.
- [List Agent Configurations](https://docs.swarms.ai/api-reference/agents/list-agent-configurations.md): Retrieve all unique agent configurations that the user has created or used, without task-specific details. Enables reuse of agent configurations across different tasks.
- [Execute Reasoning Agent Completion](https://docs.swarms.ai/api-reference/reasoning-agents/execute-reasoning-agent-completion.md): Execute a reasoning agent with advanced cognitive capabilities for complex problem-solving tasks. This is a premium-only feature.
- [Get Reasoning Agent Types](https://docs.swarms.ai/api-reference/reasoning-agents/get-reasoning-agent-types.md): Retrieve all available reasoning agent types.
- [Get API Request Logs](https://docs.swarms.ai/api-reference/logging/get-api-request-logs.md): Retrieve all API request logs for all API keys associated with the authenticated user, excluding logs containing client IP information.
- [Get User Metrics Summary](https://docs.swarms.ai/api-reference/metrics/get-user-metrics-summary.md): Retrieve a summary of the authenticated user's core usage metrics, including unique agents used, lifetime completion calls, successful completions, and recent-window completion counts.
- [Get Available AI Models](https://docs.swarms.ai/api-reference/models/get-available-ai-models.md): Retrieve comprehensive information about all AI models available for use in agent and swarm configurations.
- [List Models (OpenAI-Compatible)](https://docs.swarms.ai/api-reference/models/list-models-openai-compatible.md): List all available models in the OpenAI-compatible format. Use with any OpenAI SDK or client that discovers models via GET /v1/models.
- [Get Rate Limits and Usage](https://docs.swarms.ai/api-reference/rate-limiting/get-rate-limits-and-usage.md): Retrieve current rate limit status and usage statistics for the authenticated user across multiple time windows.
- [Get Available API Tools](https://docs.swarms.ai/api-reference/tool-management/get-available-api-tools.md): Retrieve comprehensive information about all available tools and capabilities supported by the Swarms API.
- [Execute Batched Grid Workflow](https://docs.swarms.ai/api-reference/batched-grid-workflow/execute-batched-grid-workflow.md): Execute a batched grid workflow enabling parallel execution of multiple agents across multiple tasks in a single request. This is a premium-only feature.
- [Execute Graph Workflow](https://docs.swarms.ai/api-reference/graph-workflow/execute-graph-workflow.md): Execute a graph workflow with directed agent nodes and edges. Enables complex multi-agent collaboration with parallel execution, automatic compilation, and comprehensive workflow orchestration.
- [Generate Agent Configurations From a Task](https://docs.swarms.ai/api-reference/auto-agent-builder/generate-agent-configurations-from-a-task.md): Generate a roster of agent configurations for a task. A single builder agent designs the team and returns ready-to-post AgentSpec entries — the generated agents are not executed by this endpoint.
- [Get Comprehensive Pricing Details](https://docs.swarms.ai/api-reference/pricing/get-comprehensive-pricing-details.md): Retrieves comprehensive pricing details for all API features including usage costs, service costs, and special pricing features.
- [Credit Balance](https://docs.swarms.ai/api-reference/account-management/credit-balance.md): Retrieves the current API credit balance for the authenticated user.
- [Client Setup & Basic Usage](https://docs.swarms.ai/docs/examples/examples/client-setup.md): Learn how to set up the Swarms API client and perform basic operations like checking health, models, and rate limits.
- [Single Agent Overview](https://docs.swarms.ai/docs/examples/examples/agent-overview.md): Learn how to create and run single AI agents for specific tasks using the Swarms API.
- [Client Example](https://docs.swarms.ai/docs/examples/api_examples/client_example.md): Python code example for setting up the Swarms API client and performing basic operations.
- [Structured Outputs Example](https://docs.swarms.ai/docs/examples/examples/structured-outputs.md): Extract structured JSON data from unstructured text using schema-enforced outputs
- [Streaming Responses](https://docs.swarms.ai/docs/examples/examples/streaming.md): Real-time streaming responses for immediate agent feedback
- [Search-Enabled Agents](https://docs.swarms.ai/docs/examples/examples/search-enabled.md): Agents with web search capabilities for real-time information retrieval
- [Vision Capabilities](https://docs.swarms.ai/docs/examples/examples/vision-capabilities.md): Enable agents to process and analyze images for visual understanding
- [Image Processing with a Marketplace Prompt](https://docs.swarms.ai/docs/examples/examples/image-with-marketplace-prompt.md): 3-step tutorial: create a Swarms agent that processes images using a prebuilt prompt from the marketplace
- [MCP Integration](https://docs.swarms.ai/docs/examples/examples/mcp-integration.md): Integrate Model Context Protocol servers for external data access and tools
- [Agent Handoffs Example](https://docs.swarms.ai/docs/examples/examples/agent-handoffs.md): Build agents that delegate tasks to specialized handoff agents for focused expertise
- [Sub-Agent Delegation Example](https://docs.swarms.ai/docs/examples/examples/sub-agent-delegation.md): Build a market analysis system where a coordinator agent dynamically creates and delegates to specialized sub-agents
- [Claude Opus 4.8](https://docs.swarms.ai/docs/examples/examples/claude-opus-4-8.md): Run single agents and multi-agent swarms on Anthropic's strongest model via the Swarms API.
- [Claude Fable 5](https://docs.swarms.ai/docs/examples/examples/claude-fable-5.md): Run single agents, sequential pipelines, concurrent fan-outs, hierarchical swarms, and group chats on Anthropic's most capable model via the Swarms API.
- [Reasoning Agents for Hard Analytical Problems](https://docs.swarms.ai/docs/examples/examples/reasoning-agents-tutorial.md): Solve a competition-grade multi-step accrual accounting problem end-to-end with a reasoning agent — the same task a normal LLM call hallucinates on.
- [Conversation History (Multi-Turn Agents)](https://docs.swarms.ai/docs/examples/examples/conversation-history.md): Build chatbots and research assistants that remember earlier turns by threading the history field through /v1/agent/completions.
- [Single Agent Completion (REST)](https://docs.swarms.ai/docs/examples/api_examples/agent_completion_single_agent.md): Python example using the Agent Completions endpoint to run a single research agent with the new AgentCompletion format.
- [Fully Autonomous Agent Loop](https://docs.swarms.ai/docs/examples/api_examples/autonomous_agent_tutorial.md): Tutorial for building fully autonomous agents that plan, execute, and summarize multi-step tasks using max_loops="auto".
- [OpenAI-Compatible Chat Completions](https://docs.swarms.ai/docs/examples/examples/openai-compatible.md): Drop-in usage of the Swarms API with the OpenAI SDK — basic completion, streaming, multi-turn chat, and vision in Python, TypeScript, Go, and Rust.
- [Sequential Workflow Example](https://docs.swarms.ai/docs/examples/examples/sequential-workflow.md): Build a legal document review pipeline with SequentialWorkflow
- [Concurrent Workflow Example](https://docs.swarms.ai/docs/examples/examples/concurrent-workflow.md): Build a competitive intelligence dashboard with ConcurrentWorkflow
- [Hierarchical Workflow Example](https://docs.swarms.ai/docs/examples/examples/hierarchical-workflow.md): Build a software development team with HierarchicalSwarm
- [Multi-Agent Router Example](https://docs.swarms.ai/docs/examples/examples/multi-agent-router.md): Build an IT helpdesk with intelligent ticket routing using MultiAgentRouter
- [Mixture of Agents Example](https://docs.swarms.ai/docs/examples/examples/mixture-of-agents.md): Build an investment due diligence system with MixtureOfAgents
- [Majority Voting Example](https://docs.swarms.ai/docs/examples/examples/majority-voting.md): Build a multi-agent code review board with MajorityVoting
- [Group Chat Example](https://docs.swarms.ai/docs/examples/examples/group-chat.md): Build a product strategy brainstorm with GroupChat
- [Graph Workflow Example](https://docs.swarms.ai/docs/examples/examples/graph-workflow.md): Build a content creation pipeline with Graph Workflow
- [Graph Workflows for Production Pipelines](https://docs.swarms.ai/docs/examples/examples/graph-workflows-production.md): Build production fan-out/fan-in DAGs with parallel branches that converge into a synthesis node. SDR enrichment pipeline with three parallel research agents, a synthesis agent, and a scoring agent.
- [Debate With Judge Example](https://docs.swarms.ai/docs/examples/examples/debate-with-judge.md): Build a structured debate with progressive refinement using DebateWithJudge
- [Heavy Swarm Example](https://docs.swarms.ai/docs/examples/examples/heavy-swarm.md): Run deep multi-perspective research and analysis with HeavySwarm
- [Round Robin Example](https://docs.swarms.ai/docs/examples/examples/round-robin.md): Build a collaborative research team with RoundRobin
- [LLM Council Example](https://docs.swarms.ai/docs/examples/examples/llm-council.md): Build a multi-model council with peer review and synthesis using LLMCouncil
- [Council as Judge Example](https://docs.swarms.ai/docs/examples/examples/council-as-judge.md): Build a multi-dimensional AI response evaluation system with CouncilAsAJudge
- [Function Tools in Multi-Agent Swarms](https://docs.swarms.ai/docs/examples/examples/tools-in-swarms.md): Attach OpenAI-style function tools to agents inside a multi-agent swarm.
- [Streaming Tokens from Multi-Agent Swarms](https://docs.swarms.ai/docs/examples/examples/swarm-streaming.md): Stream individual tokens from every agent in a SequentialWorkflow or AgentRearrange swarm in real time, including detecting parallel-phase interleaving.
- [Graph Workflow Edge Formats Reference](https://docs.swarms.ai/docs/examples/examples/graph-workflow-edge-formats.md): The supported edge syntaxes for the Swarms Graph Workflow endpoint — dict form and dict with metadata — plus the list forms the API rejects, with side-by-side examples building the same DAG.
- [Tagging Graph Workflow Edges with Metadata](https://docs.swarms.ai/docs/examples/examples/graph-workflow-metadata.md): Attach severity, priority, and routing metadata to graph edges in a content moderation DAG — production observability for any DAG where ops needs to filter, group, or audit per-edge behavior.
- [Build an AI Hedge Fund Research Pipeline](https://docs.swarms.ai/docs/examples/examples/ai-hedge-fund.md): A HierarchicalSwarm of a Portfolio Manager directing Fundamentals, Technicals, and Macro analysts — then scaled overnight across a full watchlist with batch completions.
- [ETF Analysis with Batched Grid Workflow](https://docs.swarms.ai/docs/examples/examples/etf-analysis-grid.md): Fan two analyst agents across two tasks in parallel using BatchedGridWorkflow.
- [Real Estate Investment Memo Swarm](https://docs.swarms.ai/docs/examples/examples/real-estate-investment-memo.md): A HierarchicalSwarm that turns a property address and ask price into a one-page institutional investment memo — comps, market context, and financing — directed by an Investment Director.
- [Crypto Quant Agent](https://docs.swarms.ai/docs/examples/examples/crypto-quant-agent.md): A domain-specific single agent for quantitative cryptocurrency market analysis.
- [Earnings Call Analysis Swarm: Tone, Guidance, and Q&A Red Flags in 60 Seconds](https://docs.swarms.ai/docs/examples/examples/earnings-call-analysis-swarm.md): A ConcurrentWorkflow of four specialist agents plus a Synthesizer turns every earnings call transcript into a structured note — covering all 125 calls per day during peak earnings season for under $50.
- [SEC Filing Triage Pipeline: 10-K, 10-Q, and 8-K Diffs Against Prior Period](https://docs.swarms.ai/docs/examples/examples/sec-filing-triage-pipeline.md): A SequentialWorkflow that ingests EDGAR filings, extracts the load-bearing sections, diffs them against the prior period, and lands a materiality-scored memo on every name in the book before the open.
- [Options Flow Detector: Unusual Activity to Trade Ideas Intraday](https://docs.swarms.ai/docs/examples/examples/options-flow-unusual-activity.md): A ConcurrentWorkflow that scans options chains every 5 minutes, fans out flow, Greeks, and vol-surface analysis in parallel, and ships a ranked watchlist to Slack before the next print.
- [Macro Data Release Reaction Engine: CPI, NFP, and FOMC in Under 60 Seconds](https://docs.swarms.ai/docs/examples/examples/macro-data-release-engine.md): A scheduled, latency-critical reasoning swarm that parses the release the moment it crosses, models regime impact with Opus 4.8 high, and fans out asset-class trade theses to Slack before the desk has finished reading the headline.
- [Insider Trading Form 4 Monitor: Cluster Buys and Significance Scoring at Scale](https://docs.swarms.ai/docs/examples/examples/insider-form4-monitor.md): A SequentialWorkflow that parses every Form 4 filed with the SEC, scores significance against insider history, detects cluster buys, and ships a ranked end-of-day digest to Slack for the price of a takeout dinner.
- [Sell-Side Research Note → Trading Signal Pipeline](https://docs.swarms.ai/docs/examples/examples/sell-side-research-pipeline.md): A HierarchicalSwarm that ingests sell-side PDFs from Goldman, JPM, MS, and BAML — extracts rating + target + thesis deltas in parallel — and emits a structured signal ranked against consensus before the open.
- [DCF Builder + Sensitivity Tables: Per-Name Daily Refresh](https://docs.swarms.ai/docs/examples/examples/dcf-builder-sensitivity.md): Reason the assumptions with Opus 4.8 at high effort, build the DCF mechanically through a SequentialWorkflow, and refresh 50 names every night via batch completions for under $80 of overnight compute.
- [13F Tracker: Quarterly Hedge Fund Position Changes at Scale](https://docs.swarms.ai/docs/examples/examples/13f-tracker-quarterly-burst.md): Parse ~5,000 13F filings in a 48-hour quarterly burst with a fan-out GraphWorkflow, then synthesize cross-fund themes into a newsroom-ready brief — for the cost of takeout dinner.
- [Crypto On-Chain Whale Tracker: Multi-Chain Movement Classification](https://docs.swarms.ai/docs/examples/examples/crypto-onchain-whale-tracker.md): A ConcurrentWorkflow that watches the top 100 wallets across ETH, BTC, SOL, and Base every block, classifies every movement, and alerts before the chart catches up.
- [News + Sentiment → Trade Idea Engine: Portfolio-Aware](https://docs.swarms.ai/docs/examples/examples/news-driven-trade-idea-engine.md): A HierarchicalSwarm that turns a continuous news firehose into actionable, portfolio-overlapped trade theses in Slack within 60 seconds of publish.
- [Production Medical Research Pipeline](https://docs.swarms.ai/docs/examples/examples/medical-research-pipeline.md): A four-agent SequentialWorkflow that turns a clinical research question into an evidence-based, audit-ready recommendation memo for ~$1, then fans the same pipeline across an overnight queue via /v1/swarm/batch/completions.
- [Clinical Case Conference Swarm](https://docs.swarms.ai/docs/examples/examples/clinical-case-conference.md): A multi-specialty tumor-board-style swarm where an Attending Physician synthesizes Radiology, Pathology, Cardiology, and Hospitalist input into a single treatment plan.
- [Hospital Medical Team Swarm](https://docs.swarms.ai/docs/examples/examples/hospital-team.md): Learn how to create a hierarchical swarm that simulates a real medical team with a doctor leader coordinating nurses and assistants.
- [ICD-10 Medical Analysis Swarm](https://docs.swarms.ai/docs/examples/examples/icd-analysis.md): Learn how to create a concurrent workflow swarm that analyzes medical conditions using multiple specialized agents working in parallel.
- [Insurance Claims Triage at Scale](https://docs.swarms.ai/docs/examples/examples/insurance-claims-triage.md): Run a single specialized agent across 10,000 claim rows in parallel using /v1/agent/batch/completions — coverage match, fraud signal, and payout estimate per row.
- [M&A Due Diligence Swarm](https://docs.swarms.ai/docs/examples/examples/ma-due-diligence.md): A cross-functional hierarchical swarm where a Deal Lead synthesizes Financial, Legal, Tax, and Technical findings into a single deal memo with go/no-go recommendation.
- [Legal Document Review Swarm](https://docs.swarms.ai/docs/examples/examples/legal-team.md): Learn how to create a sequential workflow swarm that analyzes legal documents with multiple specialized legal experts working in sequence.
- [Legal Team Example](https://docs.swarms.ai/docs/examples/api_examples/legal_team.md): Python code example for creating a multi-agent legal document review swarm using the Swarms API.
- [McKinsey-Style Consulting Deliverable Generator](https://docs.swarms.ai/docs/examples/examples/consulting-deliverable-generator.md): A HierarchicalSwarm that takes a client brief and produces a slide-by-slide market-entry deck outline — industry analysis, customer research, competitor landscape, financial model, and a partner-ready recommendation.
- [Build a Customer Support Swarm: Triage, Reply, Escalate](https://docs.swarms.ai/docs/examples/examples/customer-support-swarm.md): A HierarchicalSwarm that classifies every inbound ticket, drafts a customer-ready reply, and routes the risky ones to a human — wired to Intercom or Zendesk in under an afternoon.
- [Build a Voice Call Center Triage System with Vapi + Swarms](https://docs.swarms.ai/docs/examples/examples/voice-call-center-triage.md): Wire a Vapi voice agent to a Swarms MultiAgentRouter so inbound calls get classified, routed, answered, and logged to your CRM in under a second per turn.
- [Catering Discovery Agent](https://docs.swarms.ai/docs/examples/examples/catering-agent.md): A single-agent build for event catering discovery — strict JSON output, web search enabled, and structured vendor recommendations ready to feed into an outreach pipeline.
- [Intelligence Triage Pipeline for Defense & Gov](https://docs.swarms.ai/docs/examples/examples/intelligence-triage-pipeline.md): A four-stage GraphWorkflow that ingests multi-source open reporting, runs parallel regional and technical analysts, stress-tests conclusions with a red team, and produces an executive brief with confidence levels.
- [Supply Chain Hierarchical Swarm](https://docs.swarms.ai/docs/examples/examples/supply-chain-swarm.md): A hierarchical swarm of logistics, inventory, and procurement specialists coordinated by a Supply Chain Director.
- [From Prototype to $10K MRR: Monetize Your Agent on the Swarms Marketplace](https://docs.swarms.ai/docs/guides/guides/monetize-agent-on-marketplace.md): A builder-to-builder playbook for packaging a working agent into a paid marketplace listing, tokenizing it for creator fees, and earning recurring revenue.
- [Build Your Personal AI Chief of Staff with Gmail, Calendar, and Notion](https://docs.swarms.ai/docs/examples/examples/personal-ai-chief-of-staff.md): Wire one conversational Swarms agent into Gmail, Google Calendar, and Notion via MCP — and get an AI Chief of Staff that runs your day for under $1.
- [Daily AI Briefings in Slack: News, Stocks, and Calendar at 7AM](https://docs.swarms.ai/docs/examples/examples/daily-slack-ai-briefings.md): A ~50-line ConcurrentWorkflow swarm that posts your morning news, market open, and calendar to Slack every weekday at 7AM via cron.
- [Build a Code Review Swarm: Security, Style, Tests, Architecture](https://docs.swarms.ai/docs/examples/examples/code-review-swarm.md): A HierarchicalSwarm of specialist reviewer agents — Security, Style, Test Coverage, Architecture — coordinated by a Lead Reviewer that posts a single, decisive PR comment to GitHub.
- [SEO Content Generation Pipeline](https://docs.swarms.ai/docs/examples/examples/seo-content-pipeline.md): Build a production-grade SEO content factory using a 4-agent Graph Workflow — feed it a URL or company description and get a fully optimized article ready to publish
- [Swarm Logs & API History](https://docs.swarms.ai/docs/examples/examples/swarm-logs.md): Access and analyze your API request logs and swarm execution history
- [Available Models](https://docs.swarms.ai/docs/examples/examples/models-available.md): Discover and explore all available AI models supported by the Swarms API
- [Available Tools](https://docs.swarms.ai/docs/examples/examples/available-tools.md): Discover and explore all available tools supported by the Swarms API
- [Available Swarm Types](https://docs.swarms.ai/docs/examples/examples/swarm-types.md): Discover all available swarm architectures and choose the right one for your use case
- [Reasoning Agent Types](https://docs.swarms.ai/docs/examples/examples/reasoning-agent-types.md): Explore different reasoning agent architectures and their applications
- [List Your Agents](https://docs.swarms.ai/docs/examples/examples/list-agents.md): 3-step quick start to list agents you created
- [Build a Usage Dashboard](https://docs.swarms.ai/docs/examples/examples/metrics-summary.md): Quick start tutorial for the /v1/metrics/summary endpoint
- [Rate Limits Example](https://docs.swarms.ai/docs/examples/api_examples/rate_limits.md): Python code example for checking API rate limits and health status using the Swarms API.
- [Get Comprehensive Pricing Details](https://docs.swarms.ai/docs/examples/examples/pricing-details-basic.md): Fetch and inspect comprehensive pricing details for all Swarms API features
- [Estimate Costs from Pricing Details](https://docs.swarms.ai/docs/examples/examples/pricing-cost-estimator.md): Use comprehensive pricing details to estimate end-to-end workload costs
- [Get Credit Balance](https://docs.swarms.ai/docs/examples/examples/account-credits.md): Retrieve your current API credit balance including regular, free, and referral credits
- [Usage Report](https://docs.swarms.ai/docs/examples/examples/usage-report.md): Retrieve daily usage breakdowns with token counts, request counts, and costs from the /v1/usage/report endpoint
- [Migration Overview](https://docs.swarms.ai/docs/guides/migration/overview.md): Moving from LangGraph, CrewAI, AutoGen, or LangChain to the Swarms API — concept mapping, key differences, and where to start
- [Migrate from LangGraph](https://docs.swarms.ai/docs/guides/migration/from-langgraph.md): Side-by-side translation guide for moving LangGraph StateGraph workflows to the Swarms API Graph Workflow
- [Migrate from CrewAI](https://docs.swarms.ai/docs/guides/migration/from-crewai.md): Side-by-side translation guide for moving CrewAI crews and tasks to the Swarms API
- [Migrate from AutoGen](https://docs.swarms.ai/docs/guides/migration/from-autogen.md): Side-by-side translation guide for moving AutoGen agent conversations and GroupChat workflows to the Swarms API
- [Migrate from LangChain](https://docs.swarms.ai/docs/guides/migration/from-langchain.md): Side-by-side translation guide for moving LangChain chains, agents, and LCEL pipelines to the Swarms API
- [Night-Mode Pricing: 50% Off Overnight Batch Workflows](https://docs.swarms.ai/docs/guides/guides/night-mode-pricing-strategy.md): Move batch swarms and overnight pipelines into the 8 PM – 6 AM Pacific window for a 50% discount on swarm-completion token costs. Includes scheduling recipes with cron and Airflow.
- [Cost Optimization Playbook](https://docs.swarms.ai/docs/guides/guides/cost-optimization-playbook.md): Cut multi-agent swarm bills 2–5× by tiering models, compressing context with structured tool outputs, and reserving frontier models for synthesis.
- [Production Readiness Checklist](https://docs.swarms.ai/docs/guides/guides/production-readiness-checklist.md): The terse, opinionated checklist for shipping the Swarms API to production: rate limits, idempotency, retries, error handling, cost monitoring, batch endpoints, and a copy-paste wrapper that does all of it.
- [Production Observability with Swarms](https://docs.swarms.ai/docs/guides/guides/production-observability.md): Wire /v1/swarm/logs, /v1/usage/costs, /v1/account/credits, and X-RateLimit-* headers into a single operator dashboard for cost, error, and quota visibility.
- [Drop-In Migration from OpenAI SDK to Swarms](https://docs.swarms.ai/docs/guides/guides/openai-sdk-drop-in.md): You already have an OpenAI client. Change a base_url and you get multi-agent for free — then upgrade to /v1/swarm/completions when you want full orchestration. A strategic migration narrative.
- [Replace Your Zapier or n8n Workflow with a Swarms Agent](https://docs.swarms.ai/docs/guides/guides/replace-zapier-with-swarms.md): Stop paying per-task fees and patching brittle if/then graphs — replace your Zaps with a single agent call that handles classification, extraction, and routing in one pass.
- [Swarms vs LangGraph vs CrewAI vs AutoGen: Benchmark on a Real Research Task](https://docs.swarms.ai/docs/guides/guides/swarms-vs-langgraph-crewai-autogen-benchmark.md): Same NVDA investment-memo task, same model, four frameworks. Swarms ships the result in ~40 LOC at half the cost; the others are competitive on quality but slower and heavier.
- [Introduction to The Swarms API Python Client](https://docs.swarms.ai/docs/guides/guides/first.md): Learn how to set up the Swarms API client and perform basic operations like checking health, models, and rate limits.
- [Building Agents with Exa Web Search](https://docs.swarms.ai/docs/guides/guides/exa-web-search.md): Create intelligent agents with real-time web search capabilities using Exa integration
- [Swarms MCP Client Proxy — Quickstart (x402)](https://docs.swarms.ai/docs/guides/guides/x402_agents.md): Use x402 to access paid endpoints on Swarms MCP Client Proxy with Python and TypeScript.
- [Agentic GDP: Measuring the New Economy of Autonomous Intelligence](https://docs.swarms.ai/docs/guides/guides/agdp.md): Measuring the machine economy and value created by autonomous agents.
- [Changelog](https://docs.swarms.ai/docs/documentation/changelog.md): Product updates and announcements
- [Multi-Agent Best Practices](https://docs.swarms.ai/docs/documentation/multi-agent/best_practices.md): 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.
- [Multi-Agent Swarm Types](https://docs.swarms.ai/docs/documentation/multi-agent/swarm_types.md): Overview of all available multi-agent architectures in the Swarms API, each designed for specific use cases and workflows
- [Cost Optimization: Mixing Models for 5x Savings](https://docs.swarms.ai/docs/guides/guides/cost-optimization.md): A strategic guide to cutting Swarms API spend by tiering models, gating expensive agents behind cheap classifiers, batching overnight for the 50% night-mode discount, and capping the only two settings that actually move the bill.

## OpenAPI Specs

- [openapi](https://docs.swarms.ai/api-reference/openapi.json)

## Optional

- [Get Your API Key](https://swarms.world/platform/api-keys)
- [Account Management](https://swarms.world/platform/account)
- [Discord](https://discord.gg/EamjgSaEQf)
- [Technical Support](https://cal.com/swarms/swarms-technical-support?overlayCalendar=true)