Swarms API Documentation - Build AI Agents & Multi-Agent Systems

Get a comprehensive list of all tools available through the Swarms API. The /v1/tools/available endpoint provides information about integrated tools and capabilities that can enhance your agents and swarms.

Tools extend agent capabilities by providing access to external services, APIs, databases, and specialized functions.

Quick Start

Python
JavaScript
cURL

import requests
import json
import os
from dotenv import load_dotenv

load_dotenv()

API_KEY = os.getenv("SWARMS_API_KEY")
BASE_URL = "https://api.swarms.world"

headers = {
    "x-api-key": API_KEY,
    "Content-Type": "application/json"
}

def get_available_tools():
    """Get all available tools"""
    response = requests.get(
        f"{BASE_URL}/v1/tools/available",
        headers=headers
    )

    if response.status_code == 200:
        return response.json()
    else:
        print(f"Error: {response.status_code} - {response.text}")
        return None

# Get available tools
tools_data = get_available_tools()
if tools_data:
    print("✅ Available tools retrieved successfully!")
    print(json.dumps(tools_data, indent=2))

const API_KEY = process.env.SWARMS_API_KEY;
const BASE_URL = "https://api.swarms.world";

const headers = {
    "x-api-key": API_KEY,
    "Content-Type": "application/json"
};

async function getAvailableTools() {
    try {
        const response = await fetch(`${BASE_URL}/v1/tools/available`, {
            method: 'GET',
            headers: headers
        });

        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }

        const data = await response.json();
        console.log("✅ Available tools retrieved successfully!");
        console.log(JSON.stringify(data, null, 2));
        return data;
    } catch (error) {
        console.error('Error:', error);
        return null;
    }
}

// Get available tools
getAvailableTools();

# Get available tools
curl -X GET "https://api.swarms.world/v1/tools/available" \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json"

# Example response:
# {
#   "status": "success",
#   "tools": [
#     "auto_search",
#     "web_scraper"
#   ]
# }

Tool Integration

Enable a tool on an agent by adding its name to the top-level tools_enabled field of the request (alongside agent_config and task). Only one of the two tools is applied per request — if auto_search is present it takes precedence over web_scraper.

Auto Search
Web Scraper

payload = {
    "agent_config": {
        "agent_name": "Research Assistant",
        "model_name": "gpt-4.1",
        "max_tokens": 2048
    },
    "task": "Find the latest developments in quantum computing and summarize the key breakthroughs.",
    "tools_enabled": ["auto_search"]
}

payload = {
    "agent_config": {
        "agent_name": "Document Analyst",
        "model_name": "gpt-4.1",
        "max_tokens": 2048
    },
    "task": "Scrape and summarize the content at https://example.com/article.",
    "tools_enabled": ["web_scraper"]
}

Tool Categories

Tool	Description	Billed As
`auto_search`	Web search powered by Exa, used to ground agent responses in current information	`agent-completions-tool-usage-exa-search` (per search)
`web_scraper`	Fetches and formats the content of a URL for the agent to read	`agent-completions-tool-usage-web-scraper` (per scrape)

Search and scrape costs are billed per use — see Pricing Details for current search_cost and scrape_cost rates.

Best Practices

Tool Selection

Match Tools to Tasks: Choose tools that best fit your specific use case
Avoid Overloading: Don’t enable too many tools for a single agent
Test Combinations: Test tool combinations to ensure they work well together
Monitor Performance: Track how tools affect response time and cost

Configuration

Set Appropriate Limits: Configure tool-specific limits and timeouts
Handle Errors Gracefully: Implement proper error handling for tool failures
Cache Results: Cache tool results when appropriate to improve performance
Security First: Ensure tools access only authorized resources

Usage Optimization

Batch Operations: Use tools that support batch operations when possible
Async Processing: Leverage asynchronous tool execution for better performance
Resource Management: Monitor tool usage and resource consumption
Cost Awareness: Be aware of costs associated with tool usage

Getting Started

Agent Capabilities

Multi-Agent Architectures

Finance & Investing

Healthcare & Life Sciences

Legal, M&A & Diligence

Customer Operations

Defense, Gov & Supply Chain

Marketing, Content & Founder Tools

API Utilities

Migration Guides

Resources

Production

Compatibility & Benchmarks

Tutorials & Integrations

Available Tools

Quick Start

Tool Integration

Tool Categories

Best Practices

Tool Selection

Configuration

Usage Optimization

​Quick Start

​Tool Integration

​Tool Categories

​Best Practices

​Tool Selection

​Configuration

​Usage Optimization

Quick Start

Tool Integration

Tool Categories

Best Practices

Tool Selection

Configuration

Usage Optimization