Quickstart

Choose your deployment

The simplest way to use Airweave is through our hosted cloud platform at app.airweave.ai.

If you prefer to run Airweave yourself, you can deploy it locally on macOS, Linux or WSL. After cloning the repository and starting the server, you will be able to open the dashboard at http://localhost:8080

$
git clone https://github.com/airweave-ai/airweave.git
>
cd airweave
>
./start.sh

Set-up Airweave client

Airweave provides SDKs for Python and Node.js. Install the package.

$
pip install airweave-sdk

Now, create and copy your API key from your Airweave dashboard.

Initialize the Airweave client with your new API key. For local deployments, set base_url to "http://localhost:8001".

1
from airweave import AirweaveSDK
2
3
airweave = AirweaveSDK(api_key="YOUR_API_KEY", base_url="https://api.airweave.ai")

Create a collection

A collection is a group of different data sources that you can search using a single endpoint.

1
collection = airweave.collections.create(name="My First Collection")
2
3
print(f"Created collection: {collection.readable_id}")

Add source connection(s) to your collection

A source connection links a specific app or database to your collection. It handles authentication and automatically syncs data.

1
source_connection = airweave.source_connections.create(
2
    name="My Stripe Connection",
3
    short_name="stripe",
4
    readable_collection_id=collection.readable_id,
5
    authentication={
6
        "credentials": {
7
            "api_key": "your_stripe_api_key"  # Replace with real API key
8
        }
9
    }
10
)
11
12
print(f"Status: {source_connection.status}")

Search your collection

You can now search your collection and get the most relevant results from all connected sources.

1
results = airweave.collections.search(
2
    readable_id=collection.readable_id,
3
    query="Find returned payments from user John Doe?",
4
)
5
6
for result in results.results:
7
  print(result)