Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/UnkleFunk/HouseMusicSwarm-/llms.txt

Use this file to discover all available pages before exploring further.

OpenSwarm is a fully open-source multi-agent AI system that gives you a complete AI team from your terminal. Instead of one model trying to do everything, you get specialists — an Orchestrator that routes work, and dedicated agents for research, data analysis, slides, documents, images, video, and even house music production. Install in 30 seconds with npm, connect your API keys, and start creating.

Quickstart

Install OpenSwarm and run your first multi-agent task in under a minute.

Configuration

Set up API keys, choose your AI provider, and enable optional integrations.

Agent Overview

Meet the 10 specialized agents and learn what each one does.

Extend OpenSwarm

Fork the repo and customize agents, tools, and instructions for your use case.

What OpenSwarm can do for you

Send one prompt and watch specialists collaborate automatically. The Orchestrator interprets your goal, dispatches the right agents in parallel or in sequence, and delivers a unified result.

Research & Analysis

Deep Research agent conducts evidence-based web research with citations. Data Analyst runs statistical models and builds charts inside an isolated IPython kernel.

Documents & Slides

Docs Agent produces Word documents and PDFs. Slides Agent generates fully designed HTML decks and exports them to PPTX.

Images & Video

Image Generation Agent uses Gemini and fal.ai for generation, editing, and compositing. Video Agent produces clips with Sora, Veo, and Seedance.

10,000+ Integrations

Virtual Assistant connects to Gmail, Slack, GitHub, HubSpot, Google Calendar, and thousands more services via Composio.

Music Production

Reference Finder matches your mix against current chart tracks. Ableton Dream Agent generates nightly song sketch templates ready to drop into Ableton Live.

Fully Customizable

Every agent’s instructions, tools, and model are in plain files. Fork the repo and reshape the entire swarm for your domain in minutes.

Get started in 3 steps

1

Install via npm

npm install -g @vrsen/openswarm
openswarm
Node.js 20+ is required. Python 3.10+ is auto-installed during setup.
2

Add your API key

The interactive setup wizard walks you through choosing an AI provider (OpenAI, Anthropic, or Google Gemini) and entering your key. Optional add-ons for Composio, web search, image generation, and video are configured in the same wizard.
3

Send your first prompt

Type any task — “Create an investor pitch for my startup”, “Research my top 5 competitors”, or “Analyze this CSV and build charts” — and the Orchestrator routes the work to the right specialists automatically.
OpenSwarm is built on Agency Swarm. Tools gracefully degrade when optional API keys are missing — you’ll get clear instructions on what to enable for each capability.

Explore the agents

Orchestrator

Routes every request to the right specialist. Never executes tasks — pure coordination via SendMessage and Handoff.

Virtual Assistant

Email, calendar, Slack, file management, and 10,000+ external integrations via Composio.

Deep Research

Evidence-based web research with citations, balanced analysis, and scholarly search.

Data Analyst

Statistical analysis, KPI tracking, and chart generation inside an isolated IPython kernel.

Slides Agent

Full HTML slide deck generation with PPTX export, image search, and theme management.

Docs Agent

Create and edit Word documents and PDFs from outlines or raw content.

Image Generation

AI image generation, editing, background removal, and image combination using Gemini and fal.ai.

Video Generation

AI video generation with Sora, Veo, and Seedance — plus trimming, combining, and subtitle tools.

Reference Finder

Capture live audio, extract features, and find matching reference tracks from Beatport and Traxsource charts.

Ableton Dream Agent

Nightly song sketch templates for Ableton Live — personalized TypeScript Extensions SDK code.

Build docs developers (and LLMs) love