README.md

  

Overview

Airweave is a tool that lets agents search any app. It connects to apps, productivity tools, databases, or document stores and transforms their contents into searchable knowledge bases, accessible through a standardized interface for agents.

The search interface is exposed via REST API or MCP. When using MCP, Airweave essentially builds a semantically searchable MCP server. The platform handles everything from auth and extraction to embedding and serving.

Table of Contents

• Airweave
  • 🎥 Watch Demo
  • Overview
  • Table of Contents
  • 🚀 Quick Start
  • 🔌 Supported Integrations
  • 💻 Usage
    • Frontend
    • API
  • 📦 SDKs
    • Python
    • TypeScript/JavaScript
  • 🔑 Key Features
  • 🔧 Technology Stack
  • 🛣️ Roadmap
  • 👥 Contributing
  • 📄 License
  • 🔗 Connect

🚀 Quick Start

Make sure docker and docker-compose are installed, then...

# 1. Clone the repository
git clone https://github.com/airweave-ai/airweave.git
cd airweave

# 2. Build and run
chmod +x start.sh
./start.sh

That's it! Access the dashboard at http://localhost:8080

🔌 Supported Integrations

💻 Usage

Frontend

• Access the UI at http://localhost:8080
• Connect sources, configure syncs, and query data

API

• Swagger docs: http://localhost:8001/docs
• Create connections, trigger syncs, and search data

📦 SDKs

Python

pip install airweave-sdk

from airweave import AirweaveSDK

client = AirweaveSDK(
    api_key="YOUR_API_KEY",
    base_url="http://localhost:8001"
)
client.collections.create_collection(
    name="name",
)

TypeScript/JavaScript

npm install @airweave/sdk
# or
yarn add @airweave/sdk

import { AirweaveSDKClient, AirweaveSDKEnvironment } from "@airweave/sdk";

const client = new AirweaveSDKClient({
    apiKey: "YOUR_API_KEY",
    environment: AirweaveSDKEnvironment.Local
});
await client.collections.createCollection({
    name: "name",
});

🔑 Key Features

• Data synchronization from 25+ sources with minimal config
• Entity extraction and transformation pipeline
• Multi-tenant architecture with OAuth2
• Incremental updates using content hashing
• Semantic search for agent queries
• Versioning for data changes
• White-labeling support for SaaS builders

🔧 Technology Stack

• Frontend: React/TypeScript with ShadCN
• Backend: FastAPI (Python)
• Databases: PostgreSQL (metadata), Qdrant (vectors)
• Deployment: Docker Compose (dev), Kubernetes (prod)

🛣️ Roadmap

• Additional source integrations
• Redis worker queues for large-scale syncs
• Webhooks for event-driven syncs
• Kubernetes support via Helm charts

👥 Contributing

We welcome contributions! Please check CONTRIBUTING.md for details.

📄 License

Airweave is released under the MIT license.

🔗 Connect

• Discord - Get help and discuss features
• GitHub Issues - Report bugs or request features
• Twitter - Follow for updates