Quickstart

1. Choose deployment

Cloud platform: To use our hosted cloud version of Airweave, visit app.airweave.ai. Currently, you can only use the cloud version if you are part of a customer organization. If you want early access, please send us an email at hello@airweave.ai with your email and how you would like your organization to be named.

Self-Hosted: To deploy Airweave on your local machine, execute the following commands on macOS, Linux, or WSL and access your dashboard at http://localhost:8080.

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

2. Set-up client

Install Airweave’s SDK for Python or JavaScript.

$
pip install airweave-sdk

Create API key by going to the dashboard in the UI, either at http://localhost:8080 or https://app.airweave.ai depending on your deployment, select “API Keys” in the sidebar and click “Create key”.

Initiate client instance with your API key. If Airweave is deployed locally, set the base_url parameter to "http://localhost:8001".

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

3. 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_collection(name="My First Collection")
2
3
print(f"Created collection: {collection.readable_id}")

4. Add source connection(s) to your collection

A source connection is an authenticated and configured link to a data source that automatically syncs data into your collection.

1
source_connection = airweave.source_connections.create_source_connection(
2
    name="My Stripe Connection",
3
    short_name="stripe",
4
    collection="my-first-collection-abc123",
5
    auth_fields={
6
        "api_key": "SK_TEST_YOUR_STRIPE_API_KEY"
7
    },
8
)
9
10
print(f"Status: {source_connection.status}")

5. Search your collection

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

Open Source & Community